Class: Akeyless::UpdateRotatedSecret

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

Overview

updateRotatedSecret is a command that updates rotated secret. [Deprecated: Use rotated-secret update commands]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateRotatedSecret

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
380
381
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 288

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::UpdateRotatedSecret` 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::UpdateRotatedSecret`. 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?(:'add_tag')
    if (value = attributes[:'add_tag']).is_a?(Array)
      self.add_tag = value
    end
  end

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

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

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

  if attributes.key?(:'aws_region')
    self.aws_region = attributes[:'aws_region']
  else
    self.aws_region = 'us-east-2'
  end

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

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

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

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

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

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

  if attributes.key?(:'new_metadata')
    self.new_metadata = attributes[:'new_metadata']
  else
    self.new_metadata = 'default_metadata'
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'rotator_creds_type')
    self.rotator_creds_type = attributes[:'rotator_creds_type']
  else
    self.rotator_creds_type = 'use-self-creds'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#add_tag ⇒ Object

List of the new tags that will be attached to this item



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

def add_tag
  @add_tag
end

#api_id ⇒ Object

API ID to rotate



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

def api_id
  @api_id
end

#api_key ⇒ Object

API key to rotate



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

def api_key
  @api_key
end

#auto_rotate ⇒ Object

Whether to automatically rotate every –rotation-interval days, or disable existing automatic rotation [true/false]



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

def auto_rotate
  @auto_rotate
end

#aws_region ⇒ Object

Aws Region (relevant only for aws)



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

def aws_region
  @aws_region
end

#custom_payload ⇒ Object

Secret payload to be sent with rotation request (relevant only for rotator-type=custom)



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

def custom_payload
  @custom_payload
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#gcp_key ⇒ Object

Base64-encoded service account private key text



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

def gcp_key
  @gcp_key
end

#grace_rotation ⇒ Object

Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]



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

def grace_rotation
  @grace_rotation
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



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

def host_provider
  @host_provider
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

Whether to keep previous version [true/false]. If not set, use default according to account settings



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

def keep_prev_version
  @keep_prev_version
end

#key ⇒ Object

The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)



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

def key
  @key
end

#name ⇒ Object

Secret name



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

def name
  @name
end

#new_metadata ⇒ Object

Deprecated - use description



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

def new_metadata
  @new_metadata
end

#new_name ⇒ Object

New item name



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

def new_name
  @new_name
end

#new_version ⇒ Object

Deprecated



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

def new_version
  @new_version
end

#provider_type ⇒ Object

Returns the value of attribute provider_type.



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

def provider_type
  @provider_type
end

#rm_tag ⇒ Object

List of the existent tags that will be removed from this item



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

def rm_tag
  @rm_tag
end

#rotate_after_disconnect ⇒ Object

Rotate the value of the secret after SRA session ends [true/false]



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

def rotate_after_disconnect
  @rotate_after_disconnect
end

#rotated_password ⇒ Object

rotated-username password



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

def rotated_password
  @rotated_password
end

#rotated_username ⇒ Object

username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it’s own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password



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

def rotated_username
  @rotated_username
end

#rotation_hour ⇒ Object

The Hour of the rotation in UTC



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

def rotation_hour
  @rotation_hour
end

#rotation_interval ⇒ Object

The number of days to wait between every automatic key rotation (7-365)



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

def rotation_interval
  @rotation_interval
end

#rotator_creds_type ⇒ Object

The credentials to connect with use-self-creds/use-target-creds



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

def rotator_creds_type
  @rotator_creds_type
end

#rotator_custom_cmd ⇒ Object

"Custom rotation command (relevant only for ssh target)



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

def rotator_custom_cmd
  @rotator_custom_cmd
end

#same_password ⇒ Object

Rotate same password for each host from the Linked Target (relevant only for Linked Target)



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

def same_password
  @same_password
end

#secure_access_allow_external_user ⇒ Object

Allow providing external user for a domain users (relevant only for rdp)



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

def secure_access_allow_external_user
  @secure_access_allow_external_user
end

#secure_access_aws_account_id ⇒ Object

The AWS account id (relevant only for aws)



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

def 
  @secure_access_aws_account_id
end

#secure_access_aws_native_cli ⇒ Object

The AWS native cli



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

def secure_access_aws_native_cli
  @secure_access_aws_native_cli
end

#secure_access_bastion_issuer ⇒ Object

Path to the SSH Certificate Issuer for your Akeyless Bastion



109
110
111
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 109

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_db_name ⇒ Object

The DB name (relevant only for DB Dynamic-Secret)



112
113
114
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 112

def secure_access_db_name
  @secure_access_db_name
end

#secure_access_db_schema ⇒ Object

The db schema (relevant only for mssql or postgresql)



115
116
117
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 115

def secure_access_db_schema
  @secure_access_db_schema
end

#secure_access_disable_concurrent_connections ⇒ Object

Enable this flag to prevent simultaneous use of the same secret



118
119
120
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 118

def secure_access_disable_concurrent_connections
  @secure_access_disable_concurrent_connections
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



121
122
123
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 121

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)



124
125
126
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 124

def secure_access_host
  @secure_access_host
end

#secure_access_rdp_domain ⇒ Object

Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret)



127
128
129
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 127

def secure_access_rdp_domain
  @secure_access_rdp_domain
end

#secure_access_rdp_user ⇒ Object

Override the RDP Domain username (relevant only for rdp)



130
131
132
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 130

def secure_access_rdp_user
  @secure_access_rdp_user
end

#secure_access_url ⇒ Object

Destination URL to inject secrets



133
134
135
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 133

def secure_access_url
  @secure_access_url
end

#secure_access_web ⇒ Object

Enable Web Secure Remote Access



136
137
138
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 136

def secure_access_web
  @secure_access_web
end

#secure_access_web_browsing ⇒ Object

Secure browser via Akeyless Web Access Bastion (relevant only for aws or azure)



139
140
141
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 139

def secure_access_web_browsing
  @secure_access_web_browsing
end

#secure_access_web_proxy ⇒ Object

Web-Proxy via Akeyless Web Access Bastion (relevant only for aws or azure)



142
143
144
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 142

def secure_access_web_proxy
  @secure_access_web_proxy
end

#ssh_password ⇒ Object

Deprecated: use RotatedPassword



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

def ssh_password
  @ssh_password
end

#ssh_username ⇒ Object

Deprecated: use RotatedUser



148
149
150
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 148

def ssh_username
  @ssh_username
end

#storage_account_key_name ⇒ Object

The name of the storage account key to rotate [key1/key2/kerb1/kerb2]



151
152
153
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 151

def 
  @storage_account_key_name
end

#token ⇒ Object

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



154
155
156
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 154

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



157
158
159
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 157

def uid_token
  @uid_token
end

#user_attribute ⇒ Object

LDAP User Attribute, Default value "cn"



160
161
162
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 160

def user_attribute
  @user_attribute
end

#user_dn ⇒ Object

LDAP User Base DN



163
164
165
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 163

def user_dn
  @user_dn
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



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 643

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



221
222
223
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 221

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'provider_type' => :'ProviderType',
    :'add_tag' => :'add-tag',
    :'api_id' => :'api-id',
    :'api_key' => :'api-key',
    :'auto_rotate' => :'auto-rotate',
    :'aws_region' => :'aws-region',
    :'custom_payload' => :'custom-payload',
    :'description' => :'description',
    :'gcp_key' => :'gcp-key',
    :'grace_rotation' => :'grace-rotation',
    :'host_provider' => :'host-provider',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'name' => :'name',
    :'new_metadata' => :'new-metadata',
    :'new_name' => :'new-name',
    :'new_version' => :'new-version',
    :'rm_tag' => :'rm-tag',
    :'rotate_after_disconnect' => :'rotate-after-disconnect',
    :'rotated_password' => :'rotated-password',
    :'rotated_username' => :'rotated-username',
    :'rotation_hour' => :'rotation-hour',
    :'rotation_interval' => :'rotation-interval',
    :'rotator_creds_type' => :'rotator-creds-type',
    :'rotator_custom_cmd' => :'rotator-custom-cmd',
    :'same_password' => :'same-password',
    :'secure_access_allow_external_user' => :'secure-access-allow-external-user',
    :'secure_access_aws_account_id' => :'secure-access-aws-account-id',
    :'secure_access_aws_native_cli' => :'secure-access-aws-native-cli',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_db_name' => :'secure-access-db-name',
    :'secure_access_db_schema' => :'secure-access-db-schema',
    :'secure_access_disable_concurrent_connections' => :'secure-access-disable-concurrent-connections',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_rdp_domain' => :'secure-access-rdp-domain',
    :'secure_access_rdp_user' => :'secure-access-rdp-user',
    :'secure_access_url' => :'secure-access-url',
    :'secure_access_web' => :'secure-access-web',
    :'secure_access_web_browsing' => :'secure-access-web-browsing',
    :'secure_access_web_proxy' => :'secure-access-web-proxy',
    :'ssh_password' => :'ssh-password',
    :'ssh_username' => :'ssh-username',
    :'storage_account_key_name' => :'storage-account-key-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_attribute' => :'user-attribute',
    :'user_dn' => :'user-dn'
  }
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



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 619

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



281
282
283
284
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 281

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'provider_type' => :'String',
    :'add_tag' => :'Array<String>',
    :'api_id' => :'String',
    :'api_key' => :'String',
    :'auto_rotate' => :'String',
    :'aws_region' => :'String',
    :'custom_payload' => :'String',
    :'description' => :'String',
    :'gcp_key' => :'String',
    :'grace_rotation' => :'String',
    :'host_provider' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'name' => :'String',
    :'new_metadata' => :'String',
    :'new_name' => :'String',
    :'new_version' => :'Boolean',
    :'rm_tag' => :'Array<String>',
    :'rotate_after_disconnect' => :'String',
    :'rotated_password' => :'String',
    :'rotated_username' => :'String',
    :'rotation_hour' => :'Integer',
    :'rotation_interval' => :'String',
    :'rotator_creds_type' => :'String',
    :'rotator_custom_cmd' => :'String',
    :'same_password' => :'String',
    :'secure_access_allow_external_user' => :'Boolean',
    :'secure_access_aws_account_id' => :'String',
    :'secure_access_aws_native_cli' => :'Boolean',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_db_name' => :'String',
    :'secure_access_db_schema' => :'String',
    :'secure_access_disable_concurrent_connections' => :'Boolean',
    :'secure_access_enable' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rdp_domain' => :'String',
    :'secure_access_rdp_user' => :'String',
    :'secure_access_url' => :'String',
    :'secure_access_web' => :'Boolean',
    :'secure_access_web_browsing' => :'Boolean',
    :'secure_access_web_proxy' => :'Boolean',
    :'ssh_password' => :'String',
    :'ssh_username' => :'String',
    :'storage_account_key_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_attribute' => :'String',
    :'user_dn' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



550
551
552
553
554
555
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
594
595
596
597
598
599
600
601
602
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 550

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      provider_type == o.provider_type &&
      add_tag == o.add_tag &&
      api_id == o.api_id &&
      api_key == o.api_key &&
      auto_rotate == o.auto_rotate &&
      aws_region == o.aws_region &&
      custom_payload == o.custom_payload &&
      description == o.description &&
      gcp_key == o.gcp_key &&
      grace_rotation == o.grace_rotation &&
      host_provider == o.host_provider &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      name == o.name &&
      new_metadata == o.new_metadata &&
      new_name == o.new_name &&
      new_version == o.new_version &&
      rm_tag == o.rm_tag &&
      rotate_after_disconnect == o.rotate_after_disconnect &&
      rotated_password == o.rotated_password &&
      rotated_username == o.rotated_username &&
      rotation_hour == o.rotation_hour &&
      rotation_interval == o.rotation_interval &&
      rotator_creds_type == o.rotator_creds_type &&
      rotator_custom_cmd == o.rotator_custom_cmd &&
      same_password == o.same_password &&
      secure_access_allow_external_user == o.secure_access_allow_external_user &&
       == o. &&
      secure_access_aws_native_cli == o.secure_access_aws_native_cli &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      secure_access_db_name == o.secure_access_db_name &&
      secure_access_db_schema == o.secure_access_db_schema &&
      secure_access_disable_concurrent_connections == o.secure_access_disable_concurrent_connections &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_host == o.secure_access_host &&
      secure_access_rdp_domain == o.secure_access_rdp_domain &&
      secure_access_rdp_user == o.secure_access_rdp_user &&
      secure_access_url == o.secure_access_url &&
      secure_access_web == o.secure_access_web &&
      secure_access_web_browsing == o.secure_access_web_browsing &&
      secure_access_web_proxy == o.secure_access_web_proxy &&
      ssh_password == o.ssh_password &&
      ssh_username == o.ssh_username &&
       == o. &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_attribute == o.user_attribute &&
      user_dn == o.user_dn
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



714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 714

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


606
607
608
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 606

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



612
613
614
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 612

def hash
  [provider_type, add_tag, api_id, api_key, auto_rotate, aws_region, custom_payload, description, gcp_key, grace_rotation, host_provider, json, keep_prev_version, key, name, new_metadata, new_name, new_version, rm_tag, rotate_after_disconnect, rotated_password, rotated_username, rotation_hour, rotation_interval, rotator_creds_type, rotator_custom_cmd, same_password, secure_access_allow_external_user, , secure_access_aws_native_cli, secure_access_bastion_issuer, secure_access_db_name, secure_access_db_schema, secure_access_disable_concurrent_connections, secure_access_enable, secure_access_host, secure_access_rdp_domain, secure_access_rdp_user, secure_access_url, secure_access_web, secure_access_web_browsing, secure_access_web_proxy, ssh_password, ssh_username, , token, uid_token, user_attribute, user_dn].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



530
531
532
533
534
535
536
537
538
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 530

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



690
691
692
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 690

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



696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 696

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



684
685
686
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 684

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



542
543
544
545
546
 
# File 'lib/akeyless/models/update_rotated_secret.rb', line 542

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