Class: IntersightClient::IamOAuthToken

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/iam_o_auth_token.rb

Overview

The meta data for generating OAuth2 token of a user. It is created when user logged in via OAuth2 using Authorization Code grant and deleted upon logout, expiration timeout or manual deletion.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IamOAuthToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 151

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::IamOAuthToken` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'iam.OAuthToken'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'iam.OAuthToken'
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_expiration_time ⇒ Object

Expiration time for the JWT token to which it can be used for api calls.



26
27
28
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 26

def access_expiration_time
  @access_expiration_time
end

#app_registration ⇒ Object

Returns the value of attribute app_registration.



51
52
53
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 51

def app_registration
  @app_registration
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 20

def class_id
  @class_id
end

#client_id ⇒ Object

The identifier of the registered application to which the token belongs.



29
30
31
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 29

def client_id
  @client_id
end

#client_ip_address ⇒ Object

The user agent IP address from which the auth token is launched.



32
33
34
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 32

def client_ip_address
  @client_ip_address
end

#client_name ⇒ Object

The name of the registered application to which the token belongs.



35
36
37
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 35

def client_name
  @client_name
end

#expiration_time ⇒ Object

Expiration time for the JWT token to which it can be refreshed.



38
39
40
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 38

def expiration_time
  @expiration_time
end

#last_login_client ⇒ Object

The client address from which last login is initiated.



41
42
43
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 41

def 
  
end

#last_login_time ⇒ Object

The last login time for user.



44
45
46
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 44

def 
  
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 23

def object_type
  @object_type
end

#permission ⇒ Object

Returns the value of attribute permission.



53
54
55
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 53

def permission
  @permission
end

#token_id ⇒ Object

Token identifier. Not the Access Token itself.



47
48
49
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 47

def token_id
  @token_id
end

#user ⇒ Object

Returns the value of attribute user.



55
56
57
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 55

def user
  @user
end

#user_meta ⇒ Object

Returns the value of attribute user_meta.



49
50
51
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 49

def user_meta
  @user_meta
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



105
106
107
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 105

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



100
101
102
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 100

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 80

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'access_expiration_time' => :'AccessExpirationTime',
    :'client_id' => :'ClientId',
    :'client_ip_address' => :'ClientIpAddress',
    :'client_name' => :'ClientName',
    :'expiration_time' => :'ExpirationTime',
    :'last_login_client' => :'LastLoginClient',
    :'last_login_time' => :'LastLoginTime',
    :'token_id' => :'TokenId',
    :'user_meta' => :'UserMeta',
    :'app_registration' => :'AppRegistration',
    :'permission' => :'Permission',
    :'user' => :'User'
  }
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



311
312
313
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 311

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



137
138
139
140
141
142
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 137

def self.openapi_all_of
  [
  :'IamOAuthTokenAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



145
146
147
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 145

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
134
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 130

def self.openapi_nullable
  Set.new([
    :'user_meta',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 110

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'access_expiration_time' => :'Time',
    :'client_id' => :'String',
    :'client_ip_address' => :'String',
    :'client_name' => :'String',
    :'expiration_time' => :'Time',
    :'last_login_client' => :'String',
    :'last_login_time' => :'Time',
    :'token_id' => :'String',
    :'user_meta' => :'IamClientMeta',
    :'app_registration' => :'IamAppRegistrationRelationship',
    :'permission' => :'IamPermissionRelationship',
    :'user' => :'IamUserRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      access_expiration_time == o.access_expiration_time &&
      client_id == o.client_id &&
      client_ip_address == o.client_ip_address &&
      client_name == o.client_name &&
      expiration_time == o.expiration_time &&
       == o. &&
       == o. &&
      token_id == o.token_id &&
      user_meta == o.user_meta &&
      app_registration == o.app_registration &&
      permission == o.permission &&
      user == o.user && super(o)
end

#_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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 342

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 = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 413

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 318

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 304

def hash
  [class_id, object_type, access_expiration_time, client_id, client_ip_address, client_name, expiration_time, , , token_id, user_meta, app_registration, permission, user].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



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 230

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

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

  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



389
390
391
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 389

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 395

def to_hash
  hash = super
  IamOAuthToken.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = IamOAuthToken.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



383
384
385
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 383

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/intersight_client/models/iam_o_auth_token.rb', line 245

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["iam.OAuthToken"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["iam.OAuthToken"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end