Class: OryHydraClient::AcceptLoginRequest
- Inherits:
-
Object
- Object
- OryHydraClient::AcceptLoginRequest
- Defined in:
- lib/ory-hydra-client/models/accept_login_request.rb
Instance Attribute Summary collapse
-
#acr ⇒ Object
ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session.
-
#context ⇒ Object
Context is an optional object which can hold arbitrary data.
-
#force_subject_identifier ⇒ Object
ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated.
-
#remember ⇒ Object
Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data.
-
#remember_for ⇒ Object
RememberFor sets how long the authentication should be remembered for in seconds.
-
#subject ⇒ Object
Subject is the user ID of the end-user that authenticated.
Class Method Summary collapse
-
.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 = {}) ⇒ AcceptLoginRequest
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 = {}) ⇒ AcceptLoginRequest
Initializes the object
67 68 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 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 67 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OryHydraClient::AcceptLoginRequest` 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 `OryHydraClient::AcceptLoginRequest`. 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') self.acr = attributes[:'acr'] end if attributes.key?(:'context') if (value = attributes[:'context']).is_a?(Hash) self.context = value end end if attributes.key?(:'force_subject_identifier') self.force_subject_identifier = attributes[:'force_subject_identifier'] end if attributes.key?(:'remember') self.remember = attributes[:'remember'] end if attributes.key?(:'remember_for') self.remember_for = attributes[:'remember_for'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end end |
Instance Attribute Details
#acr ⇒ Object
ACR sets 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.
18 19 20 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 18 def acr @acr end |
#context ⇒ Object
Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the "context" field. This is useful in scenarios where login and consent endpoints share data.
21 22 23 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 21 def context @context end |
#force_subject_identifier ⇒ Object
ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the (Pairwise Identifier Algorithm) of the OpenID Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if ‘pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client’s configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.
24 25 26 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 24 def force_subject_identifier @force_subject_identifier end |
#remember ⇒ Object
Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.
27 28 29 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 27 def remember @remember end |
#remember_for ⇒ Object
RememberFor sets how long the authentication should be remembered for in seconds. If set to ‘0`, the authorization will be remembered for the duration of the browser session (using a session cookie).
30 31 32 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 30 def remember_for @remember_for end |
#subject ⇒ Object
Subject is the user ID of the end-user that authenticated.
33 34 35 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 33 def subject @subject end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
36 37 38 39 40 41 42 43 44 45 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 36 def self.attribute_map { :'acr' => :'acr', :'context' => :'context', :'force_subject_identifier' => :'force_subject_identifier', :'remember' => :'remember', :'remember_for' => :'remember_for', :'subject' => :'subject' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
153 154 155 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 153 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
60 61 62 63 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 60 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
48 49 50 51 52 53 54 55 56 57 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 48 def self.openapi_types { :'acr' => :'String', :'context' => :'Hash<String, Object>', :'force_subject_identifier' => :'String', :'remember' => :'Boolean', :'remember_for' => :'Integer', :'subject' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
127 128 129 130 131 132 133 134 135 136 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 127 def ==(o) return true if self.equal?(o) self.class == o.class && acr == o.acr && context == o.context && force_subject_identifier == o.force_subject_identifier && remember == o.remember && remember_for == o.remember_for && subject == o.subject end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 181 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 OryHydraClient.const_get(type).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
250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 250 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
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 160 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
140 141 142 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 140 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
146 147 148 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 146 def hash [acr, context, force_subject_identifier, remember, remember_for, subject].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
109 110 111 112 113 114 115 116 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 109 def list_invalid_properties invalid_properties = Array.new if @subject.nil? invalid_properties.push('invalid value for "subject", subject cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
226 227 228 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 226 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 232 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
220 221 222 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 220 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
120 121 122 123 |
# File 'lib/ory-hydra-client/models/accept_login_request.rb', line 120 def valid? return false if @subject.nil? true end |