Class: OryClient::UpdateLoginFlowWithOidcMethod

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

Overview

Update Login Flow with OpenID Connect Method

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateLoginFlowWithOidcMethod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
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
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#csrf_token ⇒ Object

The CSRF Token



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

def csrf_token
  @csrf_token
end

#id_token ⇒ Object

IDToken is an optional id token provided by an OIDC provider If submitted, it is verified using the OIDC provider’s public key set and the claims are used to populate the OIDC credentials of the identity. If the OIDC provider does not store additional claims (such as name, etc.) in the IDToken itself, you can use the ‘traits` field to populate the identity’s traits. Note, that Apple only includes the users email in the IDToken. Supported providers are Apple



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

def id_token
  @id_token
end

#id_token_nonce ⇒ Object

IDTokenNonce is the nonce, used when generating the IDToken. If the provider supports nonce validation, the nonce will be validated against this value and required.



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

def id_token_nonce
  @id_token_nonce
end

#method ⇒ Object

Method to use This field must be set to ‘oidc` when using the oidc method.



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

def method
  @method
end

#provider ⇒ Object

The provider to register with



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

def provider
  @provider
end

#traits ⇒ Object

The identity traits. This is a placeholder for the registration flow.



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

def traits
  @traits
end

#transient_payload ⇒ Object

Transient data to pass along to any webhooks



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

def transient_payload
  @transient_payload
end

#upstream_parameters ⇒ Object

UpstreamParameters are the parameters that are passed to the upstream identity provider. These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: ‘login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. `hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`.



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

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



213
214
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
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 213

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



58
59
60
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 58

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
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 44

def self.attribute_map
  {
    :'csrf_token' => :'csrf_token',
    :'id_token' => :'id_token',
    :'id_token_nonce' => :'id_token_nonce',
    :'method' => :'method',
    :'provider' => :'provider',
    :'traits' => :'traits',
    :'transient_payload' => :'transient_payload',
    :'upstream_parameters' => :'upstream_parameters'
  }
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



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

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



77
78
79
80
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'csrf_token' => :'String',
    :'id_token' => :'String',
    :'id_token_nonce' => :'String',
    :'method' => :'String',
    :'provider' => :'String',
    :'traits' => :'Object',
    :'transient_payload' => :'Object',
    :'upstream_parameters' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      csrf_token == o.csrf_token &&
      id_token == o.id_token &&
      id_token_nonce == o.id_token_nonce &&
      method == o.method &&
      provider == o.provider &&
      traits == o.traits &&
      transient_payload == o.transient_payload &&
      upstream_parameters == o.upstream_parameters
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



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

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


176
177
178
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 182

def hash
  [csrf_token, id_token, id_token_nonce, method, provider, traits, transient_payload, upstream_parameters].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



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 136

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

  if @provider.nil?
    invalid_properties.push('invalid value for "provider", provider 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



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

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



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

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



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

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



152
153
154
155
156
157
 
# File 'lib/ory-client/models/update_login_flow_with_oidc_method.rb', line 152

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