Class: OryClient::LoginFlow

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

Overview

This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client. Once a login flow is completed successfully, a session cookie or session token will be issued.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoginFlow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
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
251
252
253
254
255
256
257
258
 
# File 'lib/ory-client/models/login_flow.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

The active login method If set contains the login method used. If the flow is new, it is unset. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode



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

def active
  @active
end

#created_at ⇒ Object

CreatedAt is a helper struct field for gobuffalo.pop.



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

def created_at
  @created_at
end

#expires_at ⇒ Object

ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.



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

def expires_at
  @expires_at
end

#id ⇒ Object

ID represents the flow’s unique ID. When performing the login flow, this represents the id in the login UI’s query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id>



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

def id
  @id
end

#issued_at ⇒ Object

IssuedAt is the time (UTC) when the flow started.



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

def issued_at
  @issued_at
end

#oauth2_login_challenge ⇒ Object

Ory OAuth 2.0 Login Challenge. This value is set using the ‘login_challenge` query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.



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

def 
  @oauth2_login_challenge
end

#oauth2_login_request ⇒ Object

Returns the value of attribute oauth2_login_request.



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

def 
  @oauth2_login_request
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



39
40
41
 
# File 'lib/ory-client/models/login_flow.rb', line 39

def organization_id
  @organization_id
end

#refresh ⇒ Object

Refresh stores whether this login flow should enforce re-authentication.



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

def refresh
  @refresh
end

#request_url ⇒ Object

RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL’s path or query for example.



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

def request_url
  @request_url
end

#requested_aal ⇒ Object

Returns the value of attribute requested_aal.



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

def requested_aal
  @requested_aal
end

#return_to ⇒ Object

ReturnTo contains the requested return_to URL.



50
51
52
 
# File 'lib/ory-client/models/login_flow.rb', line 50

def return_to
  @return_to
end

#session_token_exchange_code ⇒ Object

SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type "api", and only on creating the login flow.



53
54
55
 
# File 'lib/ory-client/models/login_flow.rb', line 53

def session_token_exchange_code
  @session_token_exchange_code
end

#state ⇒ Object

State represents the state of this request: choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed.



56
57
58
 
# File 'lib/ory-client/models/login_flow.rb', line 56

def state
  @state
end

#transient_payload ⇒ Object

TransientPayload is used to pass data from the login to hooks and email templates



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

def transient_payload
  @transient_payload
end

#type ⇒ Object

The flow type can either be ‘api` or `browser`.



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

def type
  @type
end

#ui ⇒ Object

Returns the value of attribute ui.



64
65
66
 
# File 'lib/ory-client/models/login_flow.rb', line 64

def ui
  @ui
end

#updated_at ⇒ Object

UpdatedAt is a helper struct field for gobuffalo.pop.



67
68
69
 
# File 'lib/ory-client/models/login_flow.rb', line 67

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



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/ory-client/models/login_flow.rb', line 441

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



116
117
118
 
# File 'lib/ory-client/models/login_flow.rb', line 116

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



121
122
123
 
# File 'lib/ory-client/models/login_flow.rb', line 121

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ory-client/models/login_flow.rb', line 92

def self.attribute_map
  {
    :'active' => :'active',
    :'created_at' => :'created_at',
    :'expires_at' => :'expires_at',
    :'id' => :'id',
    :'issued_at' => :'issued_at',
    :'oauth2_login_challenge' => :'oauth2_login_challenge',
    :'oauth2_login_request' => :'oauth2_login_request',
    :'organization_id' => :'organization_id',
    :'refresh' => :'refresh',
    :'request_url' => :'request_url',
    :'requested_aal' => :'requested_aal',
    :'return_to' => :'return_to',
    :'session_token_exchange_code' => :'session_token_exchange_code',
    :'state' => :'state',
    :'transient_payload' => :'transient_payload',
    :'type' => :'type',
    :'ui' => :'ui',
    :'updated_at' => :'updated_at'
  }
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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/ory-client/models/login_flow.rb', line 417

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



150
151
152
153
154
155
 
# File 'lib/ory-client/models/login_flow.rb', line 150

def self.openapi_nullable
  Set.new([
    :'organization_id',
    :'state',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ory-client/models/login_flow.rb', line 126

def self.openapi_types
  {
    :'active' => :'String',
    :'created_at' => :'Time',
    :'expires_at' => :'Time',
    :'id' => :'String',
    :'issued_at' => :'Time',
    :'oauth2_login_challenge' => :'String',
    :'oauth2_login_request' => :'OAuth2LoginRequest',
    :'organization_id' => :'String',
    :'refresh' => :'Boolean',
    :'request_url' => :'String',
    :'requested_aal' => :'AuthenticatorAssuranceLevel',
    :'return_to' => :'String',
    :'session_token_exchange_code' => :'String',
    :'state' => :'Object',
    :'transient_payload' => :'Object',
    :'type' => :'String',
    :'ui' => :'UiContainer',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ory-client/models/login_flow.rb', line 379

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      created_at == o.created_at &&
      expires_at == o.expires_at &&
      id == o.id &&
      issued_at == o.issued_at &&
       == o. &&
       == o. &&
      organization_id == o.organization_id &&
      refresh == o.refresh &&
      request_url == o.request_url &&
      requested_aal == o.requested_aal &&
      return_to == o.return_to &&
      session_token_exchange_code == o.session_token_exchange_code &&
      state == o.state &&
      transient_payload == o.transient_payload &&
      type == o.type &&
      ui == o.ui &&
      updated_at == o.updated_at
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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/ory-client/models/login_flow.rb', line 512

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


404
405
406
 
# File 'lib/ory-client/models/login_flow.rb', line 404

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



410
411
412
 
# File 'lib/ory-client/models/login_flow.rb', line 410

def hash
  [active, created_at, expires_at, id, issued_at, , , organization_id, refresh, request_url, requested_aal, return_to, session_token_exchange_code, state, transient_payload, type, ui, updated_at].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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/ory-client/models/login_flow.rb', line 262

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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @issued_at.nil?
    invalid_properties.push('invalid value for "issued_at", issued_at cannot be nil.')
  end

  if @request_url.nil?
    invalid_properties.push('invalid value for "request_url", request_url cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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



488
489
490
 
# File 'lib/ory-client/models/login_flow.rb', line 488

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



494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/ory-client/models/login_flow.rb', line 494

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



482
483
484
 
# File 'lib/ory-client/models/login_flow.rb', line 482

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



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/ory-client/models/login_flow.rb', line 294

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  active_validator = EnumAttributeValidator.new('String', ["password", "oidc", "totp", "lookup_secret", "webauthn", "code", "passkey", "profile", "saml", "link_recovery", "code_recovery"])
  return false unless active_validator.valid?(@active)
  return false if @expires_at.nil?
  return false if @id.nil?
  return false if @issued_at.nil?
  return false if @request_url.nil?
  return false if @type.nil?
  return false if @ui.nil?
  true
end