Class: OryHydraClient::OAuth2LoginRequest
- Inherits:
-
Object
- Object
- OryHydraClient::OAuth2LoginRequest
- Defined in:
- lib/ory-hydra-client/models/o_auth2_login_request.rb
Instance Attribute Summary collapse
-
#challenge ⇒ Object
ID is the identifier ("login challenge") of the login request.
-
#client ⇒ Object
Returns the value of attribute client.
-
#oidc_context ⇒ Object
Returns the value of attribute oidc_context.
-
#request_url ⇒ Object
RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client.
-
#requested_access_token_audience ⇒ Object
Returns the value of attribute requested_access_token_audience.
-
#requested_scope ⇒ Object
Returns the value of attribute requested_scope.
-
#session_id ⇒ Object
SessionID is the login session ID.
-
#skip ⇒ Object
Skip, if true, implies that the client has requested the same scopes from the same user previously.
-
#subject ⇒ Object
Subject is the user ID of the end-user that authenticated.
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 = {}) ⇒ OAuth2LoginRequest
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 = {}) ⇒ OAuth2LoginRequest
Initializes the object
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 133 134 135 136 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 84 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OryHydraClient::OAuth2LoginRequest` 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::OAuth2LoginRequest`. 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?(:'challenge') self.challenge = attributes[:'challenge'] end if attributes.key?(:'client') self.client = attributes[:'client'] end if attributes.key?(:'oidc_context') self.oidc_context = attributes[:'oidc_context'] end if attributes.key?(:'request_url') self.request_url = attributes[:'request_url'] end if attributes.key?(:'requested_access_token_audience') if (value = attributes[:'requested_access_token_audience']).is_a?(Array) self.requested_access_token_audience = value end end if attributes.key?(:'requested_scope') if (value = attributes[:'requested_scope']).is_a?(Array) self.requested_scope = value end end if attributes.key?(:'session_id') self.session_id = attributes[:'session_id'] end if attributes.key?(:'skip') self.skip = attributes[:'skip'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end end |
Instance Attribute Details
#challenge ⇒ Object
ID is the identifier ("login challenge") of the login request. It is used to identify the session.
19 20 21 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 19 def challenge @challenge end |
#client ⇒ Object
Returns the value of attribute client.
21 22 23 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 21 def client @client end |
#oidc_context ⇒ Object
Returns the value of attribute oidc_context.
23 24 25 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 23 def oidc_context @oidc_context end |
#request_url ⇒ Object
RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
26 27 28 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 26 def request_url @request_url end |
#requested_access_token_audience ⇒ Object
Returns the value of attribute requested_access_token_audience.
28 29 30 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 28 def requested_access_token_audience @requested_access_token_audience end |
#requested_scope ⇒ Object
Returns the value of attribute requested_scope.
30 31 32 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 30 def requested_scope @requested_scope end |
#session_id ⇒ Object
SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It’s value can generally be used to associate consecutive login requests by a certain user.
33 34 35 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 33 def session_id @session_id end |
#skip ⇒ Object
Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
36 37 38 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 36 def skip @skip end |
#subject ⇒ Object
Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and ‘skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.
39 40 41 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 39 def subject @subject end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
57 58 59 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 57 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 42 def self.attribute_map { :'challenge' => :'challenge', :'client' => :'client', :'oidc_context' => :'oidc_context', :'request_url' => :'request_url', :'requested_access_token_audience' => :'requested_access_token_audience', :'requested_scope' => :'requested_scope', :'session_id' => :'session_id', :'skip' => :'skip', :'subject' => :'subject' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
217 218 219 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 217 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
77 78 79 80 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 77 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 62 def self.openapi_types { :'challenge' => :'String', :'client' => :'OAuth2Client', :'oidc_context' => :'OAuth2ConsentRequestOpenIDConnectContext', :'request_url' => :'String', :'requested_access_token_audience' => :'Array<String>', :'requested_scope' => :'Array<String>', :'session_id' => :'String', :'skip' => :'Boolean', :'subject' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 188 def ==(o) return true if self.equal?(o) self.class == o.class && challenge == o.challenge && client == o.client && oidc_context == o.oidc_context && request_url == o.request_url && requested_access_token_audience == o.requested_access_token_audience && requested_scope == o.requested_scope && session_id == o.session_id && skip == o.skip && subject == o.subject end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 248 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 = OryHydraClient.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
319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 319 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
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 224 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) 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
204 205 206 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 204 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
210 211 212 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 210 def hash [challenge, client, oidc_context, request_url, requested_access_token_audience, requested_scope, session_id, skip, subject].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 140 def list_invalid_properties invalid_properties = Array.new if @challenge.nil? invalid_properties.push('invalid value for "challenge", challenge cannot be nil.') end if @client.nil? invalid_properties.push('invalid value for "client", client cannot be nil.') end if @request_url.nil? invalid_properties.push('invalid value for "request_url", request_url cannot be nil.') end if @requested_access_token_audience.nil? invalid_properties.push('invalid value for "requested_access_token_audience", requested_access_token_audience cannot be nil.') end if @requested_scope.nil? invalid_properties.push('invalid value for "requested_scope", requested_scope cannot be nil.') end if @skip.nil? invalid_properties.push('invalid value for "skip", skip cannot be nil.') end 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)
295 296 297 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 295 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 301 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
289 290 291 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 289 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
175 176 177 178 179 180 181 182 183 184 |
# File 'lib/ory-hydra-client/models/o_auth2_login_request.rb', line 175 def valid? return false if @challenge.nil? return false if @client.nil? return false if @request_url.nil? return false if @requested_access_token_audience.nil? return false if @requested_scope.nil? return false if @skip.nil? return false if @subject.nil? true end |