Class: IntersightClient::IamIdp

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

Overview

The SAML identity provider such as Cisco, that has been used to log in to Intersight.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
236
237
 
# File 'lib/intersight_client/models/iam_idp.rb', line 154

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'saml'
  end

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

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

  if attributes.key?(:'system')
    self.system = attributes[:'system']
  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.



43
44
45
 
# File 'lib/intersight_client/models/iam_idp.rb', line 43

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.rb', line 20

def class_id
  @class_id
end

#domain_name ⇒ Object

Email domain name of the user for this IdP. 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.rb', line 26

def domain_name
  @domain_name
end

#enable_single_logout ⇒ Object

Setting that indicates whether ‘Single Logout (SLO)’ has been enabled for this IdP.



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

def enable_single_logout
  @enable_single_logout
end

#idp_entity_id ⇒ Object

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



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

def idp_entity_id
  @idp_entity_id
end

#ldap_policy ⇒ Object

Returns the value of attribute ldap_policy.



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

def ldap_policy
  @ldap_policy
end

#metadata ⇒ Object

SAML metadata of the IdP.



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

def metadata
  @metadata
end

#name ⇒ Object

The name of the Identity Provider, for example Cisco, Okta, or OneID.



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

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.rb', line 23

def object_type
  @object_type
end

#system ⇒ Object

Returns the value of attribute system.



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

def system
  @system
end

#type ⇒ Object

Authentication protocol used by the IdP. * saml - Use SAML as the authentication protocol for sign-on. * oidc - Open ID connect to be used as an authentication protocol for sign-on. * local - The local authentication method to be used for sign-on. Local type is set to default for the Intersight Appliance IdP.



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

def type
  @type
end

#user_preferences ⇒ Object

An array of relationships to iamUserPreference resources.



50
51
52
 
# File 'lib/intersight_client/models/iam_idp.rb', line 50

def user_preferences
  @user_preferences
end

#usergroups ⇒ Object

An array of relationships to iamUserGroup resources.



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

def usergroups
  @usergroups
end

#users ⇒ Object

An array of relationships to iamUser resources.



56
57
58
 
# File 'lib/intersight_client/models/iam_idp.rb', line 56

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)



106
107
108
 
# File 'lib/intersight_client/models/iam_idp.rb', line 106

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)



101
102
103
 
# File 'lib/intersight_client/models/iam_idp.rb', line 101

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'domain_name' => :'DomainName',
    :'enable_single_logout' => :'EnableSingleLogout',
    :'idp_entity_id' => :'IdpEntityId',
    :'metadata' => :'Metadata',
    :'name' => :'Name',
    :'type' => :'Type',
    :'account' => :'Account',
    :'ldap_policy' => :'LdapPolicy',
    :'system' => :'System',
    :'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



351
352
353
 
# File 'lib/intersight_client/models/iam_idp.rb', line 351

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



140
141
142
143
144
145
 
# File 'lib/intersight_client/models/iam_idp.rb', line 140

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



148
149
150
 
# File 'lib/intersight_client/models/iam_idp.rb', line 148

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
135
136
137
 
# File 'lib/intersight_client/models/iam_idp.rb', line 131

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'domain_name' => :'String',
    :'enable_single_logout' => :'Boolean',
    :'idp_entity_id' => :'String',
    :'metadata' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'account' => :'IamAccountRelationship',
    :'ldap_policy' => :'IamLdapPolicyRelationship',
    :'system' => :'IamSystemRelationship',
    :'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



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

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 &&
      enable_single_logout == o.enable_single_logout &&
      idp_entity_id == o.idp_entity_id &&
      metadata == o.metadata &&
      name == o.name &&
      type == o.type &&
       == o. &&
      ldap_policy == o.ldap_policy &&
      system == o.system &&
      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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/iam_idp.rb', line 382

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/intersight_client/models/iam_idp.rb', line 453

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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/intersight_client/models/iam_idp.rb', line 358

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/intersight_client/models/iam_idp.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/intersight_client/models/iam_idp.rb', line 344

def hash
  [class_id, object_type, domain_name, enable_single_logout, idp_entity_id, metadata, name, type, , ldap_policy, system, 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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/intersight_client/models/iam_idp.rb', line 241

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

  pattern = Regexp.new(/^$|^[a-zA-Z0-9](?:[a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*$/)
  if !@domain_name.nil? && @domain_name !~ pattern
    invalid_properties.push("invalid value for \"domain_name\", must conform to the pattern #{pattern}.")
  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



429
430
431
 
# File 'lib/intersight_client/models/iam_idp.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intersight_client/models/iam_idp.rb', line 435

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



423
424
425
 
# File 'lib/intersight_client/models/iam_idp.rb', line 423

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



261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/intersight_client/models/iam_idp.rb', line 261

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["iam.Idp"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["iam.Idp"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@domain_name.nil? && @domain_name !~ Regexp.new(/^$|^[a-zA-Z0-9](?:[a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*$/)
  type_validator = EnumAttributeValidator.new('String', ["saml", "oidc", "local"])
  return false unless type_validator.valid?(@type)
  true && super
end