Class: IntersightClient::IamLdapBaseProperties

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/iam_ldap_base_properties.rb

Overview

Base settings of LDAP required while configuring LDAP policy.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IamLdapBaseProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
238
239
240
241
242
243
244
245
246
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 159

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

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

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

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

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

  if attributes.key?(:'bind_method')
    self.bind_method = attributes[:'bind_method']
  else
    self.bind_method = 'LoginCredentials'
  end

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

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

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

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

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

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

  if attributes.key?(:'nested_group_search_depth')
    self.nested_group_search_depth = attributes[:'nested_group_search_depth']
  else
    self.nested_group_search_depth = 128
  end

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

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 0
  end
end

Instance Attribute Details

#attribute ⇒ Object

Role and locale information of the user.



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

def attribute
  @attribute
end

#base_dn ⇒ Object

Base Distinguished Name (DN). Starting point from where server will search for users and groups.



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

def base_dn
  @base_dn
end

#bind_dn ⇒ Object

Distinguished Name (DN) of the user, that is used to authenticate against LDAP servers.



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

def bind_dn
  @bind_dn
end

#bind_method ⇒ Object

Authentication method to access LDAP servers. * LoginCredentials - Requires the user credentials. If the bind process fails, then user is denied access. * Anonymous - Requires no username and password. If this option is selected and the LDAP server is configured for Anonymous logins, then the user gains access. * ConfiguredCredentials - Requires a known set of credentials to be specified for the initial bind process. If the initial bind process succeeds, then the distinguished name (DN) of the user name is queried and re-used for the re-binding process. If the re-binding process fails, then the user is denied access.



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

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

def class_id
  @class_id
end

#domain ⇒ Object

The IPv4 domain that all users must be in.



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

def domain
  @domain
end

#enable_encryption ⇒ Object

If enabled, the endpoint encrypts all information it sends to the LDAP server.



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

def enable_encryption
  @enable_encryption
end

#enable_group_authorization ⇒ Object

If enabled, user authorization is also done at the group level for LDAP users not in the local user database.



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

def enable_group_authorization
  @enable_group_authorization
end

#filter ⇒ Object

Criteria to identify entries in search requests.



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

def filter
  @filter
end

#group_attribute ⇒ Object

Groups to which an LDAP entry belongs.



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

def group_attribute
  @group_attribute
end

#is_password_set ⇒ Object

Indicates whether the value of the ‘password’ property has been set.



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

def is_password_set
  @is_password_set
end

#nested_group_search_depth ⇒ Object

Search depth to look for a nested LDAP group in an LDAP group map.



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

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

def object_type
  @object_type
end

#password ⇒ Object

The password of the user for initial bind process. It can be any string that adheres to the following constraints. It can have character except spaces, tabs, line breaks. It cannot be more than 254 characters.



59
60
61
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 59

def password
  @password
end

#timeout ⇒ Object

LDAP authentication timeout duration, in seconds.



62
63
64
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 62

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



113
114
115
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 113

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)



108
109
110
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 108

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.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 87

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'attribute' => :'Attribute',
    :'base_dn' => :'BaseDn',
    :'bind_dn' => :'BindDn',
    :'bind_method' => :'BindMethod',
    :'domain' => :'Domain',
    :'enable_encryption' => :'EnableEncryption',
    :'enable_group_authorization' => :'EnableGroupAuthorization',
    :'filter' => :'Filter',
    :'group_attribute' => :'GroupAttribute',
    :'is_password_set' => :'IsPasswordSet',
    :'nested_group_search_depth' => :'NestedGroupSearchDepth',
    :'password' => :'Password',
    :'timeout' => :'Timeout'
  }
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



525
526
527
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 525

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



145
146
147
148
149
150
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 145

def self.openapi_all_of
  [
  :'IamLdapBasePropertiesAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



153
154
155
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 153

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 139

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 118

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'attribute' => :'String',
    :'base_dn' => :'String',
    :'bind_dn' => :'String',
    :'bind_method' => :'String',
    :'domain' => :'String',
    :'enable_encryption' => :'Boolean',
    :'enable_group_authorization' => :'Boolean',
    :'filter' => :'String',
    :'group_attribute' => :'String',
    :'is_password_set' => :'Boolean',
    :'nested_group_search_depth' => :'Integer',
    :'password' => :'String',
    :'timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 490

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      attribute == o.attribute &&
      base_dn == o.base_dn &&
      bind_dn == o.bind_dn &&
      bind_method == o.bind_method &&
      domain == o.domain &&
      enable_encryption == o.enable_encryption &&
      enable_group_authorization == o.enable_group_authorization &&
      filter == o.filter &&
      group_attribute == o.group_attribute &&
      is_password_set == o.is_password_set &&
      nested_group_search_depth == o.nested_group_search_depth &&
      password == o.password &&
      timeout == o.timeout && 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



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 556

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



627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 627

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



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 532

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


512
513
514
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 512

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



518
519
520
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 518

def hash
  [class_id, object_type, attribute, base_dn, bind_dn, bind_method, domain, enable_encryption, enable_group_authorization, filter, group_attribute, is_password_set, nested_group_search_depth, password, timeout].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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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_ldap_base_properties.rb', line 250

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

  if !@base_dn.nil? && @base_dn.to_s.length > 254
    invalid_properties.push('invalid value for "base_dn", the character length must be smaller than or equal to 254.')
  end

  if !@bind_dn.nil? && @bind_dn.to_s.length > 254
    invalid_properties.push('invalid value for "bind_dn", the character length must be smaller than or equal to 254.')
  end

  if !@bind_dn.nil? && @bind_dn.to_s.length < 0
    invalid_properties.push('invalid value for "bind_dn", the character length must be great than or equal to 0.')
  end

  if !@domain.nil? && @domain.to_s.length > 255
    invalid_properties.push('invalid value for "domain", the character length must be smaller than or equal to 255.')
  end

  pattern = Regexp.new(/^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\.\-]*[a-zA-Z0-9]))$/)
  if !@domain.nil? && @domain !~ pattern
    invalid_properties.push("invalid value for \"domain\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^$|^[a-zA-Z0-9(][a-zA-Z0-9_#@$%&\-\^|()*=:!,.]*[a-zA-Z0-9\-)]$/)
  if !@filter.nil? && @filter !~ pattern
    invalid_properties.push("invalid value for \"filter\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^$|^[a-zA-Z0-9][a-zA-Z0-9_#@$%&\-\^]*[a-zA-Z0-9\-]$/)
  if !@group_attribute.nil? && @group_attribute !~ pattern
    invalid_properties.push("invalid value for \"group_attribute\", must conform to the pattern #{pattern}.")
  end

  if !@nested_group_search_depth.nil? && @nested_group_search_depth > 128
    invalid_properties.push('invalid value for "nested_group_search_depth", must be smaller than or equal to 128.')
  end

  if !@nested_group_search_depth.nil? && @nested_group_search_depth < 1
    invalid_properties.push('invalid value for "nested_group_search_depth", must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^[\S+]{0,254}$/)
  if !@password.nil? && @password !~ pattern
    invalid_properties.push("invalid value for \"password\", must conform to the pattern #{pattern}.")
  end

  if !@timeout.nil? && @timeout > 180
    invalid_properties.push('invalid value for "timeout", must be smaller than or equal to 180.')
  end

  if !@timeout.nil? && @timeout < 0
    invalid_properties.push('invalid value for "timeout", must be greater than or equal to 0.')
  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



603
604
605
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 603

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



609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 609

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



597
598
599
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 597

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/intersight_client/models/iam_ldap_base_properties.rb', line 322

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["iam.LdapBaseProperties"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["iam.LdapBaseProperties"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@attribute.nil? && @attribute !~ Regexp.new(/^$|^[a-zA-Z0-9][a-zA-Z0-9\-\.]*[a-zA-Z0-9\-]$/)
  return false if !@base_dn.nil? && @base_dn.to_s.length > 254
  return false if !@bind_dn.nil? && @bind_dn.to_s.length > 254
  return false if !@bind_dn.nil? && @bind_dn.to_s.length < 0
  bind_method_validator = EnumAttributeValidator.new('String', ["LoginCredentials", "Anonymous", "ConfiguredCredentials"])
  return false unless bind_method_validator.valid?(@bind_method)
  return false if !@domain.nil? && @domain.to_s.length > 255
  return false if !@domain.nil? && @domain !~ Regexp.new(/^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\.\-]*[a-zA-Z0-9]))$/)
  return false if !@filter.nil? && @filter !~ Regexp.new(/^$|^[a-zA-Z0-9(][a-zA-Z0-9_#@$%&\-\^|()*=:!,.]*[a-zA-Z0-9\-)]$/)
  return false if !@group_attribute.nil? && @group_attribute !~ Regexp.new(/^$|^[a-zA-Z0-9][a-zA-Z0-9_#@$%&\-\^]*[a-zA-Z0-9\-]$/)
  return false if !@nested_group_search_depth.nil? && @nested_group_search_depth > 128
  return false if !@nested_group_search_depth.nil? && @nested_group_search_depth < 1
  return false if !@password.nil? && @password !~ Regexp.new(/^[\S+]{0,254}$/)
  return false if !@timeout.nil? && @timeout > 180
  return false if !@timeout.nil? && @timeout < 0
  true && super
end