Class: OryHydraClient::UserinfoResponse
- Inherits:
-
Object
- Object
- OryHydraClient::UserinfoResponse
- Defined in:
- lib/ory-hydra-client/models/userinfo_response.rb
Overview
UserinfoResponse UserinfoResponse UserinfoResponse UserinfoResponse The userinfo response
Instance Attribute Summary collapse
-
#birthdate ⇒ Object
End-User’s birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.
-
#email ⇒ Object
End-User’s preferred e-mail address.
-
#email_verified ⇒ Object
True if the End-User’s e-mail address has been verified; otherwise false.
-
#family_name ⇒ Object
Surname(s) or last name(s) of the End-User.
-
#gender ⇒ Object
End-User’s gender.
-
#given_name ⇒ Object
Given name(s) or first name(s) of the End-User.
-
#locale ⇒ Object
End-User’s locale, represented as a BCP47 [RFC5646] language tag.
-
#middle_name ⇒ Object
Middle name(s) of the End-User.
-
#name ⇒ Object
End-User’s full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User’s locale and preferences.
-
#nickname ⇒ Object
Casual name of the End-User that may or may not be the same as the given_name.
-
#phone_number ⇒ Object
End-User’s preferred telephone number.
-
#phone_number_verified ⇒ Object
True if the End-User’s phone number has been verified; otherwise false.
-
#picture ⇒ Object
URL of the End-User’s profile picture.
-
#preferred_username ⇒ Object
Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe.
-
#profile ⇒ Object
URL of the End-User’s profile page.
-
#sub ⇒ Object
Subject - Identifier for the End-User at the IssuerURL.
-
#updated_at ⇒ Object
Time the End-User’s information was last updated.
-
#website ⇒ Object
URL of the End-User’s Web page or blog.
-
#zoneinfo ⇒ Object
String from zoneinfo [zoneinfo] time zone database representing the End-User’s time zone.
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 = {}) ⇒ UserinfoResponse
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 = {}) ⇒ UserinfoResponse
Initializes the object
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 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 217 218 219 220 221 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 133 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OryHydraClient::UserinfoResponse` 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::UserinfoResponse`. 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?(:'birthdate') self.birthdate = attributes[:'birthdate'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'email_verified') self.email_verified = attributes[:'email_verified'] end if attributes.key?(:'family_name') self.family_name = attributes[:'family_name'] end if attributes.key?(:'gender') self.gender = attributes[:'gender'] end if attributes.key?(:'given_name') self.given_name = attributes[:'given_name'] end if attributes.key?(:'locale') self.locale = attributes[:'locale'] end if attributes.key?(:'middle_name') self.middle_name = attributes[:'middle_name'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'nickname') self.nickname = attributes[:'nickname'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.key?(:'phone_number_verified') self.phone_number_verified = attributes[:'phone_number_verified'] end if attributes.key?(:'picture') self.picture = attributes[:'picture'] end if attributes.key?(:'preferred_username') self.preferred_username = attributes[:'preferred_username'] end if attributes.key?(:'profile') self.profile = attributes[:'profile'] end if attributes.key?(:'sub') self.sub = attributes[:'sub'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.key?(:'website') self.website = attributes[:'website'] end if attributes.key?(:'zoneinfo') self.zoneinfo = attributes[:'zoneinfo'] end end |
Instance Attribute Details
#birthdate ⇒ Object
End-User’s birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform’s date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
19 20 21 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 19 def birthdate @birthdate end |
#email ⇒ Object
End-User’s preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
22 23 24 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 22 def email @email end |
#email_verified ⇒ Object
True if the End-User’s e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
25 26 27 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 25 def email_verified @email_verified end |
#family_name ⇒ Object
Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
28 29 30 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 28 def family_name @family_name end |
#gender ⇒ Object
End-User’s gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
31 32 33 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 31 def gender @gender end |
#given_name ⇒ Object
Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
34 35 36 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 34 def given_name @given_name end |
#locale ⇒ Object
End-User’s locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
37 38 39 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 37 def locale @locale end |
#middle_name ⇒ Object
Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
40 41 42 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 40 def middle_name @middle_name end |
#name ⇒ Object
End-User’s full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User’s locale and preferences.
43 44 45 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 43 def name @name end |
#nickname ⇒ Object
Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
46 47 48 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 46 def nickname @nickname end |
#phone_number ⇒ Object
End-User’s preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, 1 (425) 555-1212 or 56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
49 50 51 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 49 def phone_number @phone_number end |
#phone_number_verified ⇒ Object
True if the End-User’s phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
52 53 54 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 52 def phone_number_verified @phone_number_verified end |
#picture ⇒ Object
URL of the End-User’s profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
55 56 57 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 55 def picture @picture end |
#preferred_username ⇒ Object
Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace.
58 59 60 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 58 def preferred_username @preferred_username end |
#profile ⇒ Object
URL of the End-User’s profile page. The contents of this Web page SHOULD be about the End-User.
61 62 63 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 61 def profile @profile end |
#sub ⇒ Object
Subject - Identifier for the End-User at the IssuerURL.
64 65 66 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 64 def sub @sub end |
#updated_at ⇒ Object
Time the End-User’s information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
67 68 69 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 67 def updated_at @updated_at end |
#website ⇒ Object
URL of the End-User’s Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
70 71 72 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 70 def website @website end |
#zoneinfo ⇒ Object
String from zoneinfo [zoneinfo] time zone database representing the End-User’s time zone. For example, Europe/Paris or America/Los_Angeles.
73 74 75 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 73 def zoneinfo @zoneinfo end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 76 def self.attribute_map { :'birthdate' => :'birthdate', :'email' => :'email', :'email_verified' => :'email_verified', :'family_name' => :'family_name', :'gender' => :'gender', :'given_name' => :'given_name', :'locale' => :'locale', :'middle_name' => :'middle_name', :'name' => :'name', :'nickname' => :'nickname', :'phone_number' => :'phone_number', :'phone_number_verified' => :'phone_number_verified', :'picture' => :'picture', :'preferred_username' => :'preferred_username', :'profile' => :'profile', :'sub' => :'sub', :'updated_at' => :'updated_at', :'website' => :'website', :'zoneinfo' => :'zoneinfo' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
277 278 279 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 277 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
126 127 128 129 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 126 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 101 def self.openapi_types { :'birthdate' => :'String', :'email' => :'String', :'email_verified' => :'Boolean', :'family_name' => :'String', :'gender' => :'String', :'given_name' => :'String', :'locale' => :'String', :'middle_name' => :'String', :'name' => :'String', :'nickname' => :'String', :'phone_number' => :'String', :'phone_number_verified' => :'Boolean', :'picture' => :'String', :'preferred_username' => :'String', :'profile' => :'String', :'sub' => :'String', :'updated_at' => :'Integer', :'website' => :'String', :'zoneinfo' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 238 def ==(o) return true if self.equal?(o) self.class == o.class && birthdate == o.birthdate && email == o.email && email_verified == o.email_verified && family_name == o.family_name && gender == o.gender && given_name == o.given_name && locale == o.locale && middle_name == o.middle_name && name == o.name && nickname == o.nickname && phone_number == o.phone_number && phone_number_verified == o.phone_number_verified && picture == o.picture && preferred_username == o.preferred_username && profile == o.profile && sub == o.sub && updated_at == o.updated_at && website == o.website && zoneinfo == o.zoneinfo end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 305 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
374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 374 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
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 284 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
264 265 266 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 264 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
270 271 272 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 270 def hash [birthdate, email, email_verified, family_name, gender, given_name, locale, middle_name, name, nickname, phone_number, phone_number_verified, picture, preferred_username, profile, sub, updated_at, website, zoneinfo].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
225 226 227 228 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 225 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
350 351 352 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 350 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
356 357 358 359 360 361 362 363 364 365 366 367 368 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 356 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
344 345 346 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 344 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
232 233 234 |
# File 'lib/ory-hydra-client/models/userinfo_response.rb', line 232 def valid? true end |