class OryHydraClient::ConsentRequest
Attributes
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.
ID is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.
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.
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.
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.
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.
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.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/ory-hydra-client/models/consent_request.rb, line 68 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ory-hydra-client/models/consent_request.rb, line 50 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ory-hydra-client/models/consent_request.rb, line 216 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ory-hydra-client/models/consent_request.rb, line 98 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') self.context = attributes[:'context'] 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
List of attributes with nullable: true
# File lib/ory-hydra-client/models/consent_request.rb, line 91 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ory-hydra-client/models/consent_request.rb, line 73 def self.openapi_types { :'acr' => :'String', :'challenge' => :'String', :'client' => :'OAuth2Client', :'context' => :'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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ory-hydra-client/models/consent_request.rb, line 184 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ory-hydra-client/models/consent_request.rb, line 246 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/ory-hydra-client/models/consent_request.rb, line 317 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ory-hydra-client/models/consent_request.rb, line 223 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
@see the `==` method @param [Object] Object to be compared
# File lib/ory-hydra-client/models/consent_request.rb, line 203 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ory-hydra-client/models/consent_request.rb, line 209 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ory-hydra-client/models/consent_request.rb, line 166 def list_invalid_properties invalid_properties = Array.new if @challenge.nil? invalid_properties.push('invalid value for "challenge", challenge cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ory-hydra-client/models/consent_request.rb, line 299 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ory-hydra-client/models/consent_request.rb, line 287 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ory-hydra-client/models/consent_request.rb, line 177 def valid? return false if @challenge.nil? true end