class OryHydraClient::AcceptLoginRequest
Attributes
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.
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.
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.
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).
Subject is the user ID of the end-user that authenticated.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/ory-hydra-client/models/accept_login_request.rb, line 48 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# 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
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/accept_login_request.rb, line 156 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/accept_login_request.rb, line 72 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') self.context = attributes[:'context'] 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
List of attributes with nullable: true
# File lib/ory-hydra-client/models/accept_login_request.rb, line 65 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ory-hydra-client/models/accept_login_request.rb, line 53 def self.openapi_types { :'acr' => :'String', :'context' => :'Object', :'force_subject_identifier' => :'String', :'remember' => :'Boolean', :'remember_for' => :'Integer', :'subject' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ory-hydra-client/models/accept_login_request.rb, line 130 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
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/accept_login_request.rb, line 186 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/accept_login_request.rb, line 257 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/accept_login_request.rb, line 163 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/accept_login_request.rb, line 143 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ory-hydra-client/models/accept_login_request.rb, line 149 def hash [acr, context, force_subject_identifier, remember, remember_for, 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/accept_login_request.rb, line 112 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ory-hydra-client/models/accept_login_request.rb, line 239 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/accept_login_request.rb, line 227 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/accept_login_request.rb, line 123 def valid? return false if @subject.nil? true end