Class: OryHydraClient::ConsentRequest
- Inherits:
-
Object
- Object
- OryHydraClient::ConsentRequest
- Defined in:
- lib/ory-hydra-client/models/consent_request.rb
Instance Attribute Summary collapse
-
#acr ⇒ Object
ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session.
-
#challenge ⇒ Object
Challenge is the identifier ("authorization challenge") of the consent authorization request.
-
#client ⇒ Object
Returns the value of attribute client.
-
#context ⇒ Object
Context contains arbitrary information set by the login endpoint or is empty if not set.
-
#login_challenge ⇒ Object
LoginChallenge is the login challenge this consent challenge belongs to.
-
#login_session_id ⇒ Object
LoginSessionID is the login session ID.
-
#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
RequestedScope contains the access token audience as requested by the OAuth 2.0 Client.
-
#requested_scope ⇒ Object
RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.
-
#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
-
.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 = {}) ⇒ ConsentRequest
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 = {}) ⇒ ConsentRequest
Initializes the object
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 95 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OryHydraClient::ConsentRequest` 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::ConsentRequest`. 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?(:'challenge') self.challenge = attributes[:'challenge'] end if attributes.key?(:'client') self.client = attributes[:'client'] end if attributes.key?(:'context') if (value = attributes[:'context']).is_a?(Hash) self.context = value end end if attributes.key?(:'login_challenge') self.login_challenge = attributes[:'login_challenge'] end if attributes.key?(:'login_session_id') self.login_session_id = attributes[:'login_session_id'] 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?(:'skip') self.skip = attributes[:'skip'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end end |
Instance Attribute Details
#acr ⇒ Object
ACR represents 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/consent_request.rb', line 18 def acr @acr end |
#challenge ⇒ Object
Challenge is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.
21 22 23 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 21 def challenge @challenge end |
#client ⇒ Object
Returns the value of attribute client.
23 24 25 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 23 def client @client end |
#context ⇒ Object
Context contains arbitrary information set by the login endpoint or is empty if not set.
26 27 28 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 26 def context @context end |
#login_challenge ⇒ Object
LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.
29 30 31 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 29 def login_challenge @login_challenge end |
#login_session_id ⇒ Object
LoginSessionID 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.
32 33 34 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 32 def login_session_id @login_session_id end |
#oidc_context ⇒ Object
Returns the value of attribute oidc_context.
34 35 36 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 34 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.
37 38 39 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 37 def request_url @request_url end |
#requested_access_token_audience ⇒ Object
RequestedScope contains the access token audience as requested by the OAuth 2.0 Client.
40 41 42 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 40 def requested_access_token_audience @requested_access_token_audience end |
#requested_scope ⇒ Object
RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.
43 44 45 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 43 def requested_scope @requested_scope end |
#skip ⇒ Object
Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.
46 47 48 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 46 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.
49 50 51 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 49 def subject @subject end |
Class Method Details
.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-hydra-client/models/consent_request.rb', line 52 def self.attribute_map { :'acr' => :'acr', :'challenge' => :'challenge', :'client' => :'client', :'context' => :'context', :'login_challenge' => :'login_challenge', :'login_session_id' => :'login_session_id', :'oidc_context' => :'oidc_context', :'request_url' => :'request_url', :'requested_access_token_audience' => :'requested_access_token_audience', :'requested_scope' => :'requested_scope', :'skip' => :'skip', :'subject' => :'subject' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
210 211 212 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 210 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
88 89 90 91 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 88 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 70 def self.openapi_types { :'acr' => :'String', :'challenge' => :'String', :'client' => :'OAuth2Client', :'context' => :'Hash<String, Object>', :'login_challenge' => :'String', :'login_session_id' => :'String', :'oidc_context' => :'OpenIDConnectContext', :'request_url' => :'String', :'requested_access_token_audience' => :'Array<String>', :'requested_scope' => :'Array<String>', :'skip' => :'Boolean', :'subject' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 178 def ==(o) return true if self.equal?(o) self.class == o.class && acr == o.acr && challenge == o.challenge && client == o.client && context == o.context && login_challenge == o.login_challenge && login_session_id == o.login_session_id && oidc_context == o.oidc_context && request_url == o.request_url && requested_access_token_audience == o.requested_access_token_audience && requested_scope == o.requested_scope && skip == o.skip && subject == o.subject end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
238 239 240 241 242 243 244 245 246 247 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 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 238 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
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 307 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
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 217 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
197 198 199 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 197 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
203 204 205 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 203 def hash [acr, challenge, client, context, login_challenge, login_session_id, oidc_context, request_url, requested_access_token_audience, requested_scope, skip, subject].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
165 166 167 168 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 165 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
283 284 285 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 283 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 289 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
277 278 279 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 277 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
172 173 174 |
# File 'lib/ory-hydra-client/models/consent_request.rb', line 172 def valid? true end |