Class: OryClient::AcceptOAuth2LoginRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/accept_o_auth2_login_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AcceptOAuth2LoginRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 86

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::AcceptOAuth2LoginRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::AcceptOAuth2LoginRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'acr')
    self.acr = attributes[:'acr']
  end

  if attributes.key?(:'amr')
    if (value = attributes[:'amr']).is_a?(Array)
      self.amr = value
    end
  end

  if attributes.key?(:'context')
    self.context = attributes[:'context']
  end

  if attributes.key?(:'extend_session_lifespan')
    self.extend_session_lifespan = attributes[:'extend_session_lifespan']
  end

  if attributes.key?(:'force_subject_identifier')
    self.force_subject_identifier = attributes[:'force_subject_identifier']
  end

  if attributes.key?(:'identity_provider_session_id')
    self.identity_provider_session_id = attributes[:'identity_provider_session_id']
  end

  if attributes.key?(:'remember')
    self.remember = attributes[:'remember']
  end

  if attributes.key?(:'remember_for')
    self.remember_for = attributes[:'remember_for']
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  else
    self.subject = nil
  end
end

Instance Attribute Details

#acr ⇒ Object

ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.



19
20
21
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 19

def acr
  @acr
end

#amr ⇒ Object

Returns the value of attribute amr.



21
22
23
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 21

def amr
  @amr
end

#context ⇒ Object

Returns the value of attribute context.



23
24
25
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 23

def context
  @context
end

#extend_session_lifespan ⇒ Object

Extend OAuth2 authentication session lifespan If set to ‘true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously. This value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`.



26
27
28
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 26

def extend_session_lifespan
  @extend_session_lifespan
end

#force_subject_identifier ⇒ Object

ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the (Pairwise Identifier Algorithm) of the OpenID Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if ‘pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client’s configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.



29
30
31
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 29

def force_subject_identifier
  @force_subject_identifier
end

#identity_provider_session_id ⇒ Object

IdentityProviderSessionID is the session ID of the end-user that authenticated. If specified, we will use this value to propagate the logout.



32
33
34
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 32

def identity_provider_session_id
  @identity_provider_session_id
end

#remember ⇒ Object

Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.



35
36
37
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 35

def remember
  @remember
end

#remember_for ⇒ Object

RememberFor sets how long the authentication should be remembered for in seconds. If set to ‘0`, the authorization will be remembered for the duration of the browser session (using a session cookie).



38
39
40
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 38

def remember_for
  @remember_for
end

#subject ⇒ Object

Subject is the user ID of the end-user that authenticated.



41
42
43
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 41

def subject
  @subject
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 215

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 44

def self.attribute_map
  {
    :'acr' => :'acr',
    :'amr' => :'amr',
    :'context' => :'context',
    :'extend_session_lifespan' => :'extend_session_lifespan',
    :'force_subject_identifier' => :'force_subject_identifier',
    :'identity_provider_session_id' => :'identity_provider_session_id',
    :'remember' => :'remember',
    :'remember_for' => :'remember_for',
    :'subject' => :'subject'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 191

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 79

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 64

def self.openapi_types
  {
    :'acr' => :'String',
    :'amr' => :'Array<String>',
    :'context' => :'Object',
    :'extend_session_lifespan' => :'Boolean',
    :'force_subject_identifier' => :'String',
    :'identity_provider_session_id' => :'String',
    :'remember' => :'Boolean',
    :'remember_for' => :'Integer',
    :'subject' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acr == o.acr &&
      amr == o.amr &&
      context == o.context &&
      extend_session_lifespan == o.extend_session_lifespan &&
      force_subject_identifier == o.force_subject_identifier &&
      identity_provider_session_id == o.identity_provider_session_id &&
      remember == o.remember &&
      remember_for == o.remember_for &&
      subject == o.subject
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 286

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 184

def hash
  [acr, amr, context, extend_session_lifespan, force_subject_identifier, identity_provider_session_id, remember, remember_for, subject].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
147
148
149
150
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @subject.nil?
    invalid_properties.push('invalid value for "subject", subject cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 262

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 268

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 256

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
157
158
 
# File 'lib/ory-client/models/accept_o_auth2_login_request.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @subject.nil?
  true
end