Class: OryClient::Identity

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/identity.rb

Overview

An [identity](www.ory.sh/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Identity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
231
232
233
234
235
 
# File 'lib/ory-client/models/identity.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::Identity` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::Identity`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'credentials')
    if (value = attributes[:'credentials']).is_a?(Hash)
      self.credentials = value
    end
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'metadata_admin')
    self.metadata_admin = attributes[:'metadata_admin']
  end

  if attributes.key?(:'metadata_public')
    self.metadata_public = attributes[:'metadata_public']
  end

  if attributes.key?(:'organization_id')
    self.organization_id = attributes[:'organization_id']
  end

  if attributes.key?(:'recovery_addresses')
    if (value = attributes[:'recovery_addresses']).is_a?(Array)
      self.recovery_addresses = value
    end
  end

  if attributes.key?(:'schema_id')
    self.schema_id = attributes[:'schema_id']
  else
    self.schema_id = nil
  end

  if attributes.key?(:'schema_url')
    self.schema_url = attributes[:'schema_url']
  else
    self.schema_url = nil
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'state_changed_at')
    self.state_changed_at = attributes[:'state_changed_at']
  end

  if attributes.key?(:'traits')
    self.traits = attributes[:'traits']
  else
    self.traits = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'verifiable_addresses')
    if (value = attributes[:'verifiable_addresses']).is_a?(Array)
      self.verifiable_addresses = value
    end
  end
end

Instance Attribute Details

#created_at ⇒ Object

CreatedAt is a helper struct field for gobuffalo.pop.



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

def created_at
  @created_at
end

#credentials ⇒ Object

Credentials represents all credentials that can be used for authenticating this identity.



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

def credentials
  @credentials
end

#external_id ⇒ Object

ExternalID is an optional external ID of the identity. This is used to link the identity to an external system. If set, the external ID must be unique across all identities.



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

def external_id
  @external_id
end

#id ⇒ Object

ID is the identity’s unique identifier. The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB.



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

def id
  @id
end

#metadata_admin ⇒ Object

NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-



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

def metadata_admin
  @metadata_admin
end

#metadata_public ⇒ Object

NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-



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

def metadata_public
  @metadata_public
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



37
38
39
 
# File 'lib/ory-client/models/identity.rb', line 37

def organization_id
  @organization_id
end

#recovery_addresses ⇒ Object

RecoveryAddresses contains all the addresses that can be used to recover an identity.



40
41
42
 
# File 'lib/ory-client/models/identity.rb', line 40

def recovery_addresses
  @recovery_addresses
end

#schema_id ⇒ Object

SchemaID is the ID of the JSON Schema to be used for validating the identity’s traits.



43
44
45
 
# File 'lib/ory-client/models/identity.rb', line 43

def schema_id
  @schema_id
end

#schema_url ⇒ Object

SchemaURL is the URL of the endpoint where the identity’s traits schema can be fetched from. format: url



46
47
48
 
# File 'lib/ory-client/models/identity.rb', line 46

def schema_url
  @schema_url
end

#state ⇒ Object

State is the identity’s state. This value has currently no effect. active StateActive inactive StateInactive



49
50
51
 
# File 'lib/ory-client/models/identity.rb', line 49

def state
  @state
end

#state_changed_at ⇒ Object

Returns the value of attribute state_changed_at.



51
52
53
 
# File 'lib/ory-client/models/identity.rb', line 51

def state_changed_at
  @state_changed_at
end

#traits ⇒ Object

Traits represent an identity’s traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in schema_url.



54
55
56
 
# File 'lib/ory-client/models/identity.rb', line 54

def traits
  @traits
end

#updated_at ⇒ Object

UpdatedAt is a helper struct field for gobuffalo.pop.



57
58
59
 
# File 'lib/ory-client/models/identity.rb', line 57

def updated_at
  @updated_at
end

#verifiable_addresses ⇒ Object

VerifiableAddresses contains all the addresses that can be verified by the user.



60
61
62
 
# File 'lib/ory-client/models/identity.rb', line 60

def verifiable_addresses
  @verifiable_addresses
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



106
107
108
 
# File 'lib/ory-client/models/identity.rb', line 106

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/ory-client/models/identity.rb', line 111

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ory-client/models/identity.rb', line 85

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'credentials' => :'credentials',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'metadata_admin' => :'metadata_admin',
    :'metadata_public' => :'metadata_public',
    :'organization_id' => :'organization_id',
    :'recovery_addresses' => :'recovery_addresses',
    :'schema_id' => :'schema_id',
    :'schema_url' => :'schema_url',
    :'state' => :'state',
    :'state_changed_at' => :'state_changed_at',
    :'traits' => :'traits',
    :'updated_at' => :'updated_at',
    :'verifiable_addresses' => :'verifiable_addresses'
  }
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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/ory-client/models/identity.rb', line 346

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



137
138
139
140
141
142
143
144
 
# File 'lib/ory-client/models/identity.rb', line 137

def self.openapi_nullable
  Set.new([
    :'metadata_admin',
    :'metadata_public',
    :'organization_id',
    :'traits',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/ory-client/models/identity.rb', line 116

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'credentials' => :'Hash<String, IdentityCredentials>',
    :'external_id' => :'String',
    :'id' => :'String',
    :'metadata_admin' => :'Object',
    :'metadata_public' => :'Object',
    :'organization_id' => :'String',
    :'recovery_addresses' => :'Array<RecoveryIdentityAddress>',
    :'schema_id' => :'String',
    :'schema_url' => :'String',
    :'state' => :'String',
    :'state_changed_at' => :'Time',
    :'traits' => :'Object',
    :'updated_at' => :'Time',
    :'verifiable_addresses' => :'Array<VerifiableIdentityAddress>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ory-client/models/identity.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      credentials == o.credentials &&
      external_id == o.external_id &&
      id == o.id &&
      metadata_admin == o.metadata_admin &&
      metadata_public == o.metadata_public &&
      organization_id == o.organization_id &&
      recovery_addresses == o.recovery_addresses &&
      schema_id == o.schema_id &&
      schema_url == o.schema_url &&
      state == o.state &&
      state_changed_at == o.state_changed_at &&
      traits == o.traits &&
      updated_at == o.updated_at &&
      verifiable_addresses == o.verifiable_addresses
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
 
# File 'lib/ory-client/models/identity.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



339
340
341
 
# File 'lib/ory-client/models/identity.rb', line 339

def hash
  [created_at, credentials, external_id, id, metadata_admin, metadata_public, organization_id, recovery_addresses, schema_id, schema_url, state, state_changed_at, traits, updated_at, verifiable_addresses].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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ory-client/models/identity.rb', line 239

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @schema_id.nil?
    invalid_properties.push('invalid value for "schema_id", schema_id cannot be nil.')
  end

  if @schema_url.nil?
    invalid_properties.push('invalid value for "schema_url", schema_url cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/ory-client/models/identity.rb', line 368

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



259
260
261
262
263
264
265
266
267
 
# File 'lib/ory-client/models/identity.rb', line 259

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @schema_id.nil?
  return false if @schema_url.nil?
  state_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
  return false unless state_validator.valid?(@state)
  true
end