Class: OryKratosClient::OAuth2ConsentRequestOpenIDConnectContext

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

Overview

OAuth2ConsentRequestOpenIDConnectContext struct for OAuth2ConsentRequestOpenIDConnectContext

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2ConsentRequestOpenIDConnectContext

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryKratosClient::OAuth2ConsentRequestOpenIDConnectContext` 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 `OryKratosClient::OAuth2ConsentRequestOpenIDConnectContext`. 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_values')
    if (value = attributes[:'acr_values']).is_a?(Array)
      self.acr_values = value
    end
  end

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

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

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

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

Instance Attribute Details

#acr_values ⇒ Object

ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.



20
21
22
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 20

def acr_values
  @acr_values
end

#display ⇒ Object

Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.



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

def display
  @display
end

#id_token_hint_claims ⇒ Object

IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User’s current or past authenticated session with the Client.



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

def id_token_hint_claims
  @id_token_hint_claims
end

#login_hint ⇒ Object

LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional.



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

def 
  @login_hint
end

#ui_locales ⇒ Object

UILocales is the End-User’id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.



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

def ui_locales
  @ui_locales
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 175

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 = OryKratosClient.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



46
47
48
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 35

def self.attribute_map
  {
    :'acr_values' => :'acr_values',
    :'display' => :'display',
    :'id_token_hint_claims' => :'id_token_hint_claims',
    :'login_hint' => :'login_hint',
    :'ui_locales' => :'ui_locales'
  }
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 151

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



62
63
64
65
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 51

def self.openapi_types
  {
    :'acr_values' => :'Array<String>',
    :'display' => :'String',
    :'id_token_hint_claims' => :'Hash<String, Object>',
    :'login_hint' => :'String',
    :'ui_locales' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acr_values == o.acr_values &&
      display == o.display &&
      id_token_hint_claims == o.id_token_hint_claims &&
       == o. &&
      ui_locales == o.ui_locales
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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 246

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


138
139
140
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 144

def hash
  [acr_values, display, id_token_hint_claims, , ui_locales].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



111
112
113
114
115
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



222
223
224
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 222

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 228

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



216
217
218
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 216

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



119
120
121
122
 
# File 'lib/ory-kratos-client/models/o_auth2_consent_request_open_id_connect_context.rb', line 119

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end