Class: IntersightClient::IamIdpReference

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

Overview

Default Cisco IdP for authentication.

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 = {}) ⇒ IamIdpReference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'multi_factor_authentication')
    self.multi_factor_authentication = attributes[:'multi_factor_authentication']
  else
    self.multi_factor_authentication = false
  end

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



37
38
39
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 37

def 
  @account
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_idp_reference.rb', line 20

def class_id
  @class_id
end

#domain_name ⇒ Object

The email domain name for this IdP of the user. When a user enters an email during login in the Intersight home page, the IdP is picked by matching this domain name with the email domain name for authentication.



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

def domain_name
  @domain_name
end

#idp ⇒ Object

Returns the value of attribute idp.



39
40
41
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 39

def idp
  @idp
end

#idp_entity_id ⇒ Object

Entity ID of the IdP. In SAML, the entity ID uniquely identifies the IdP/Service Provider.



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

def idp_entity_id
  @idp_entity_id
end

#multi_factor_authentication ⇒ Object

The flag represents if the second factor of authentication is required for Cisco IdP users.



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

def multi_factor_authentication
  @multi_factor_authentication
end

#name ⇒ Object

Cisco IdP reference in an account.



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

def name
  @name
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_idp_reference.rb', line 23

def object_type
  @object_type
end

#user_preferences ⇒ Object

An array of relationships to iamUserPreference resources.



42
43
44
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 42

def user_preferences
  @user_preferences
end

#usergroups ⇒ Object

An array of relationships to iamUserGroup resources.



45
46
47
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 45

def usergroups
  @usergroups
end

#users ⇒ Object

An array of relationships to iamUser resources.



48
49
50
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 48

def users
  @users
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)



95
96
97
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 95

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)



90
91
92
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 90

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.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 73

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'domain_name' => :'DomainName',
    :'idp_entity_id' => :'IdpEntityId',
    :'multi_factor_authentication' => :'MultiFactorAuthentication',
    :'name' => :'Name',
    :'account' => :'Account',
    :'idp' => :'Idp',
    :'user_preferences' => :'UserPreferences',
    :'usergroups' => :'Usergroups',
    :'users' => :'Users'
  }
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



293
294
295
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 293

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



126
127
128
129
130
131
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 126

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



134
135
136
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 134

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 117

def self.openapi_nullable
  Set.new([
    :'user_preferences',
    :'usergroups',
    :'users'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 100

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'domain_name' => :'String',
    :'idp_entity_id' => :'String',
    :'multi_factor_authentication' => :'Boolean',
    :'name' => :'String',
    :'account' => :'IamAccountRelationship',
    :'idp' => :'IamIdpRelationship',
    :'user_preferences' => :'Array<IamUserPreferenceRelationship>',
    :'usergroups' => :'Array<IamUserGroupRelationship>',
    :'users' => :'Array<IamUserRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      domain_name == o.domain_name &&
      idp_entity_id == o.idp_entity_id &&
      multi_factor_authentication == o.multi_factor_authentication &&
      name == o.name &&
       == o. &&
      idp == o.idp &&
      user_preferences == o.user_preferences &&
      usergroups == o.usergroups &&
      users == o.users && 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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 324

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



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

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 300

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 286

def hash
  [class_id, object_type, domain_name, idp_entity_id, multi_factor_authentication, name, , idp, user_preferences, usergroups, users].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



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 215

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



371
372
373
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 377

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



365
366
367
 
# File 'lib/intersight_client/models/iam_idp_reference.rb', line 365

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



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

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