Class: OryClient::OAuth2ConsentRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2ConsentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 117

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::OAuth2ConsentRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'challenge')
    self.challenge = attributes[:'challenge']
  else
    self.challenge = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acr ⇒ Object

ACR represents 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/o_auth2_consent_request.rb', line 19

def acr
  @acr
end

#amr ⇒ Object

Returns the value of attribute amr.



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

def amr
  @amr
end

#challenge ⇒ Object

Challenge is used to retrieve/accept/deny the consent request.



24
25
26
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 24

def challenge
  @challenge
end

#client ⇒ Object

Returns the value of attribute client.



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

def client
  @client
end

#consent_request_id ⇒ Object

ConsentRequestID is the ID of the consent request.



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

def consent_request_id
  @consent_request_id
end

#context ⇒ Object

Returns the value of attribute context.



31
32
33
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 31

def context
  @context
end

#device_challenge_id ⇒ Object

DeviceChallenge is the device challenge this consent challenge belongs to, if this flow was initiated by a device.



34
35
36
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 34

def device_challenge_id
  @device_challenge_id
end

#login_challenge ⇒ Object

LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.



37
38
39
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 37

def 
  @login_challenge
end

#login_session_id ⇒ Object

LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It’s value can generally be used to associate consecutive login requests by a certain user.



40
41
42
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 40

def 
  @login_session_id
end

#oidc_context ⇒ Object

Returns the value of attribute oidc_context.



42
43
44
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 42

def oidc_context
  @oidc_context
end

#request_url ⇒ Object

RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.



45
46
47
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 45

def request_url
  @request_url
end

#requested_access_token_audience ⇒ Object

Returns the value of attribute requested_access_token_audience.



47
48
49
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 47

def requested_access_token_audience
  @requested_access_token_audience
end

#requested_scope ⇒ Object

Returns the value of attribute requested_scope.



49
50
51
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 49

def requested_scope
  @requested_scope
end

#skip ⇒ Object

Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.



52
53
54
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 52

def skip
  @skip
end

#subject ⇒ Object

Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client.



55
56
57
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 55

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 291

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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 58

def self.attribute_map
  {
    :'acr' => :'acr',
    :'amr' => :'amr',
    :'challenge' => :'challenge',
    :'client' => :'client',
    :'consent_request_id' => :'consent_request_id',
    :'context' => :'context',
    :'device_challenge_id' => :'device_challenge_id',
    :'login_challenge' => :'login_challenge',
    :'login_session_id' => :'login_session_id',
    :'oidc_context' => :'oidc_context',
    :'request_url' => :'request_url',
    :'requested_access_token_audience' => :'requested_access_token_audience',
    :'requested_scope' => :'requested_scope',
    :'skip' => :'skip',
    :'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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 267

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



110
111
112
113
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 110

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 89

def self.openapi_types
  {
    :'acr' => :'String',
    :'amr' => :'Array<String>',
    :'challenge' => :'String',
    :'client' => :'OAuth2Client',
    :'consent_request_id' => :'String',
    :'context' => :'Object',
    :'device_challenge_id' => :'String',
    :'login_challenge' => :'String',
    :'login_session_id' => :'String',
    :'oidc_context' => :'OAuth2ConsentRequestOpenIDConnectContext',
    :'request_url' => :'String',
    :'requested_access_token_audience' => :'Array<String>',
    :'requested_scope' => :'Array<String>',
    :'skip' => :'Boolean',
    :'subject' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acr == o.acr &&
      amr == o.amr &&
      challenge == o.challenge &&
      client == o.client &&
      consent_request_id == o.consent_request_id &&
      context == o.context &&
      device_challenge_id == o.device_challenge_id &&
       == o. &&
       == o. &&
      oidc_context == o.oidc_context &&
      request_url == o.request_url &&
      requested_access_token_audience == o.requested_access_token_audience &&
      requested_scope == o.requested_scope &&
      skip == o.skip &&
      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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 362

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


254
255
256
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 260

def hash
  [acr, amr, challenge, client, consent_request_id, context, device_challenge_id, , , oidc_context, request_url, requested_access_token_audience, requested_scope, skip, 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



202
203
204
205
206
207
208
209
210
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 202

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @challenge.nil?
    invalid_properties.push('invalid value for "challenge", challenge 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



338
339
340
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 344

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



332
333
334
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 332

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



214
215
216
217
218
 
# File 'lib/ory-client/models/o_auth2_consent_request.rb', line 214

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