Class: OryKratosClient::SelfServiceLoginFlow
- Inherits:
-
Object
- Object
- OryKratosClient::SelfServiceLoginFlow
- Defined in:
- lib/ory-kratos-client/models/self_service_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.
Instance Attribute Summary collapse
-
#active ⇒ Object
Returns the value of attribute active.
-
#created_at ⇒ Object
CreatedAt is a helper struct field for gobuffalo.pop.
-
#expires_at ⇒ Object
ExpiresAt is the time (UTC) when the flow expires.
-
#id ⇒ Object
Returns the value of attribute id.
-
#issued_at ⇒ Object
IssuedAt is the time (UTC) when the flow started.
-
#refresh ⇒ Object
Refresh stores whether this login flow should enforce re-authentication.
-
#request_url ⇒ Object
RequestURL is the initial URL that was requested from Ory Kratos.
-
#requested_aal ⇒ Object
Returns the value of attribute requested_aal.
-
#return_to ⇒ Object
ReturnTo contains the requested return_to URL.
-
#type ⇒ Object
The flow type can either be ‘api` or `browser`.
-
#ui ⇒ Object
Returns the value of attribute ui.
-
#updated_at ⇒ Object
UpdatedAt is a helper struct field for gobuffalo.pop.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SelfServiceLoginFlow
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SelfServiceLoginFlow
Initializes the object
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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 100 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OryKratosClient::SelfServiceLoginFlow` 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::SelfServiceLoginFlow`. 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?(:'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'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'issued_at') self.issued_at = attributes[:'issued_at'] end if attributes.key?(:'refresh') self.refresh = attributes[:'refresh'] end if attributes.key?(:'request_url') self.request_url = attributes[:'request_url'] 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?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'ui') self.ui = attributes[:'ui'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end end |
Instance Attribute Details
#active ⇒ Object
Returns the value of attribute active.
19 20 21 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 19 def active @active end |
#created_at ⇒ Object
CreatedAt is a helper struct field for gobuffalo.pop.
22 23 24 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 22 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.
25 26 27 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 25 def expires_at @expires_at end |
#id ⇒ Object
Returns the value of attribute id.
27 28 29 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 27 def id @id end |
#issued_at ⇒ Object
IssuedAt is the time (UTC) when the flow started.
30 31 32 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 30 def issued_at @issued_at end |
#refresh ⇒ Object
Refresh stores whether this login flow should enforce re-authentication.
33 34 35 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 33 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.
36 37 38 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 36 def request_url @request_url end |
#requested_aal ⇒ Object
Returns the value of attribute requested_aal.
38 39 40 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 38 def requested_aal @requested_aal end |
#return_to ⇒ Object
ReturnTo contains the requested return_to URL.
41 42 43 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 41 def return_to @return_to end |
#type ⇒ Object
The flow type can either be ‘api` or `browser`.
44 45 46 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 44 def type @type end |
#ui ⇒ Object
Returns the value of attribute ui.
46 47 48 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 46 def ui @ui end |
#updated_at ⇒ Object
UpdatedAt is a helper struct field for gobuffalo.pop.
49 50 51 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 49 def updated_at @updated_at end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
70 71 72 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 70 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 52 def self.attribute_map { :'active' => :'active', :'created_at' => :'created_at', :'expires_at' => :'expires_at', :'id' => :'id', :'issued_at' => :'issued_at', :'refresh' => :'refresh', :'request_url' => :'request_url', :'requested_aal' => :'requested_aal', :'return_to' => :'return_to', :'type' => :'type', :'ui' => :'ui', :'updated_at' => :'updated_at' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
239 240 241 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 239 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
93 94 95 96 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 93 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 75 def self.openapi_types { :'active' => :'IdentityCredentialsType', :'created_at' => :'Time', :'expires_at' => :'Time', :'id' => :'String', :'issued_at' => :'Time', :'refresh' => :'Boolean', :'request_url' => :'String', :'requested_aal' => :'AuthenticatorAssuranceLevel', :'return_to' => :'String', :'type' => :'String', :'ui' => :'UiContainer', :'updated_at' => :'Time' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 207 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 && refresh == o.refresh && request_url == o.request_url && requested_aal == o.requested_aal && return_to == o.return_to && type == o.type && ui == o.ui && updated_at == o.updated_at end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 269 def _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_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 340 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 246 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end |
#eql?(o) ⇒ Boolean
226 227 228 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 226 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
232 233 234 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 232 def hash [active, created_at, expires_at, id, issued_at, refresh, request_url, requested_aal, return_to, type, ui, updated_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 164 def list_invalid_properties 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)
316 317 318 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 316 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 322 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
310 311 312 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 310 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
195 196 197 198 199 200 201 202 203 |
# File 'lib/ory-kratos-client/models/self_service_login_flow.rb', line 195 def valid? 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 |