Class: OryHydraClient::OidcUserInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-hydra-client/models/oidc_user_info.rb

Overview

OpenID Connect Userinfo

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OidcUserInfo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
222
223
224
225
226
227
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 139

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryHydraClient::OidcUserInfo` 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::OidcUserInfo`. 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.



20
21
22
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 20

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.



23
24
25
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 23

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.



26
27
28
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 26

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.



29
30
31
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 29

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.



32
33
34
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 32

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.



35
36
37
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 35

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.



38
39
40
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 38

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.



41
42
43
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 41

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.



44
45
46
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 44

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.



47
48
49
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 47

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.



50
51
52
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 50

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.



53
54
55
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 53

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.



56
57
58
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 56

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.



59
60
61
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 59

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.



62
63
64
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 62

def profile
  @profile
end

#sub ⇒ Object

Subject - Identifier for the End-User at the IssuerURL.



65
66
67
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 65

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.



68
69
70
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 68

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.



71
72
73
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 71

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.



74
75
76
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 74

def zoneinfo
  @zoneinfo
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
341
342
343
344
345
346
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 309

def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



102
103
104
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 77

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 285

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 132

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 107

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.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 246

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 380

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 278

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?

Returns:

  • Array for valid properties with the reasons



231
232
233
234
235
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 231

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



356
357
358
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 356

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 362

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

Returns:

  • (String) —

    String presentation of the object



350
351
352
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 350

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



239
240
241
242
 
# File 'lib/ory-hydra-client/models/oidc_user_info.rb', line 239

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end