Class: Akeyless::DynamicSecretUpdateLdap

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/dynamic_secret_update_ldap.rb

Overview

dynamicSecretUpdateLdap is a command that updates ldap dynamic secret

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicSecretUpdateLdap

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
247
248
249
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 193

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

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

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

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

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

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

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

  if attributes.key?(:'fixed_user_claim_keyname')
    self.fixed_user_claim_keyname = attributes[:'fixed_user_claim_keyname']
  else
    self.fixed_user_claim_keyname = 'ext_username'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'user_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '60m'
  end
end

Instance Attribute Details

#bind_dn ⇒ Object

Bind DN



22
23
24
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 22

def bind_dn
  @bind_dn
end

#bind_dn_password ⇒ Object

Bind DN Password



25
26
27
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 25

def bind_dn_password
  @bind_dn_password
end

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]



28
29
30
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 28

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



31
32
33
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 31

def description
  @description
end

#external_username ⇒ Object

Externally provided username [true/false]



34
35
36
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 34

def external_username
  @external_username
end

#fixed_user_claim_keyname ⇒ Object

For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for external-username=true)



37
38
39
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 37

def fixed_user_claim_keyname
  @fixed_user_claim_keyname
end

#group_dn ⇒ Object

Group DN which the temporary user should be added



40
41
42
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 40

def group_dn
  @group_dn
end

#host_provider ⇒ Object

Host provider type [explicit/target], Default Host provider is explicit, Relevant only for Secure Remote Access of ssh cert issuer, ldap rotated secret and ldap dynamic secret



43
44
45
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 43

def host_provider
  @host_provider
end

#json ⇒ Object

Set output format to JSON



46
47
48
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 46

def json
  @json
end

#ldap_ca_cert ⇒ Object

CA Certificate File Content



49
50
51
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 49

def ldap_ca_cert
  @ldap_ca_cert
end

#ldap_url ⇒ Object

LDAP Server URL



52
53
54
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 52

def ldap_url
  @ldap_url
end

#name ⇒ Object

Dynamic secret name



55
56
57
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 55

def name
  @name
end

#new_name ⇒ Object

Dynamic secret name



58
59
60
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 58

def new_name
  @new_name
end

#password_length ⇒ Object

The length of the password to be generated



61
62
63
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 61

def password_length
  @password_length
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



64
65
66
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 64

def producer_encryption_key_name
  @producer_encryption_key_name
end

#provider_type ⇒ Object

Returns the value of attribute provider_type.



19
20
21
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 19

def provider_type
  @provider_type
end

#secure_access_delay ⇒ Object

The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds



67
68
69
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 67

def secure_access_delay
  @secure_access_delay
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



70
71
72
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 70

def secure_access_enable
  @secure_access_enable
end

#secure_access_host ⇒ Object

Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)



73
74
75
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 73

def secure_access_host
  @secure_access_host
end

#secure_access_rd_gateway_server ⇒ Object

RD Gateway server



76
77
78
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 76

def secure_access_rd_gateway_server
  @secure_access_rd_gateway_server
end

#secure_access_rdp_domain ⇒ Object

Required when the Dynamic Secret is used for a domain user



79
80
81
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 79

def secure_access_rdp_domain
  @secure_access_rdp_domain
end

#tags ⇒ Object

Add tags attached to this object



82
83
84
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 82

def tags
  @tags
end

#target ⇒ Object

A list of linked targets to be associated, Relevant only for Secure Remote Access for ssh cert issuer, ldap rotated secret and ldap dynamic secret, To specify multiple targets use argument multiple times



85
86
87
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 85

def target
  @target
end

#target_name ⇒ Object

Target name



88
89
90
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 88

def target_name
  @target_name
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



91
92
93
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 91

def token
  @token
end

#token_expiration ⇒ Object

Token expiration



94
95
96
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 94

def token_expiration
  @token_expiration
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



97
98
99
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 97

def uid_token
  @uid_token
end

#user_attribute ⇒ Object

User Attribute



100
101
102
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 100

def user_attribute
  @user_attribute
end

#user_dn ⇒ Object

User DN



103
104
105
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 103

def user_dn
  @user_dn
end

#user_ttl ⇒ Object

User TTL



106
107
108
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 106

def user_ttl
  @user_ttl
end

Class Method Details

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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 439

def self._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 = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



145
146
147
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 145

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 109

def self.attribute_map
  {
    :'provider_type' => :'ProviderType',
    :'bind_dn' => :'bind-dn',
    :'bind_dn_password' => :'bind-dn-password',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'external_username' => :'external-username',
    :'fixed_user_claim_keyname' => :'fixed-user-claim-keyname',
    :'group_dn' => :'group-dn',
    :'host_provider' => :'host-provider',
    :'json' => :'json',
    :'ldap_ca_cert' => :'ldap-ca-cert',
    :'ldap_url' => :'ldap-url',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'password_length' => :'password-length',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'secure_access_delay' => :'secure-access-delay',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_rd_gateway_server' => :'secure-access-rd-gateway-server',
    :'secure_access_rdp_domain' => :'secure-access-rdp-domain',
    :'tags' => :'tags',
    :'target' => :'target',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'token_expiration' => :'token-expiration',
    :'uid_token' => :'uid-token',
    :'user_attribute' => :'user-attribute',
    :'user_dn' => :'user-dn',
    :'user_ttl' => :'user-ttl'
  }
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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 415

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



186
187
188
189
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 186

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 150

def self.openapi_types
  {
    :'provider_type' => :'String',
    :'bind_dn' => :'String',
    :'bind_dn_password' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'external_username' => :'String',
    :'fixed_user_claim_keyname' => :'String',
    :'group_dn' => :'String',
    :'host_provider' => :'String',
    :'json' => :'Boolean',
    :'ldap_ca_cert' => :'String',
    :'ldap_url' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'password_length' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'secure_access_delay' => :'Integer',
    :'secure_access_enable' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rd_gateway_server' => :'String',
    :'secure_access_rdp_domain' => :'String',
    :'tags' => :'Array<String>',
    :'target' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'token_expiration' => :'String',
    :'uid_token' => :'String',
    :'user_attribute' => :'String',
    :'user_dn' => :'String',
    :'user_ttl' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      provider_type == o.provider_type &&
      bind_dn == o.bind_dn &&
      bind_dn_password == o.bind_dn_password &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      external_username == o.external_username &&
      fixed_user_claim_keyname == o.fixed_user_claim_keyname &&
      group_dn == o.group_dn &&
      host_provider == o.host_provider &&
      json == o.json &&
      ldap_ca_cert == o.ldap_ca_cert &&
      ldap_url == o.ldap_url &&
      name == o.name &&
      new_name == o.new_name &&
      password_length == o.password_length &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      secure_access_delay == o.secure_access_delay &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_host == o.secure_access_host &&
      secure_access_rd_gateway_server == o.secure_access_rd_gateway_server &&
      secure_access_rdp_domain == o.secure_access_rdp_domain &&
      tags == o.tags &&
      target == o.target &&
      target_name == o.target_name &&
      token == o.token &&
      token_expiration == o.token_expiration &&
      uid_token == o.uid_token &&
      user_attribute == o.user_attribute &&
      user_dn == o.user_dn &&
      user_ttl == o.user_ttl
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



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 510

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


402
403
404
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 402

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



408
409
410
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 408

def hash
  [provider_type, bind_dn, bind_dn_password, delete_protection, description, external_username, fixed_user_claim_keyname, group_dn, host_provider, json, ldap_ca_cert, ldap_url, name, new_name, password_length, producer_encryption_key_name, secure_access_delay, secure_access_enable, secure_access_host, secure_access_rd_gateway_server, secure_access_rdp_domain, tags, target, target_name, token, token_expiration, uid_token, user_attribute, user_dn, user_ttl].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



345
346
347
348
349
350
351
352
353
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 345

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



486
487
488
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 486

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



492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 492

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



480
481
482
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 480

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



357
358
359
360
361
 
# File 'lib/akeyless/models/dynamic_secret_update_ldap.rb', line 357

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  true
end