Class: Akeyless::RotatedSecretCreateCustom

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RotatedSecretCreateCustom

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
342
343
344
345
346
347
348
349
350
351
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 193

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

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

  if attributes.key?(:'custom_payload')
    self.custom_payload = attributes[:'custom_payload']
  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?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

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

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

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

  if attributes.key?(:'password_length')
    self.password_length = attributes[:'password_length']
  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?(:'rotation_event_in')
    if (value = attributes[:'rotation_event_in']).is_a?(Array)
      self.rotation_event_in = value
    end
  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?(:'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_bastion_issuer')
    self.secure_access_bastion_issuer = attributes[:'secure_access_bastion_issuer']
  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_ssh_user')
    self.secure_access_ssh_user = attributes[:'secure_access_ssh_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?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

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

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

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

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

Instance Attribute Details

#authentication_credentialsObject

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



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

def authentication_credentials
  @authentication_credentials
end

#auto_rotateObject

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



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

def auto_rotate
  @auto_rotate
end

#custom_payloadObject

Secret payload to be sent with rotation request



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

def custom_payload
  @custom_payload
end

#delete_protectionObject

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



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

def delete_protection
  @delete_protection
end

#descriptionObject

Description of the object



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

def description
  @description
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#keyObject

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



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

def key
  @key
end

#max_versionsObject

Set the maximum number of versions, limited by the account settings defaults.



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

def max_versions
  @max_versions
end

#nameObject

Rotated secret name



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

def name
  @name
end

#password_lengthObject

The length of the password to be generated



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

def password_length
  @password_length
end

#rotate_after_disconnectObject

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



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

def rotate_after_disconnect
  @rotate_after_disconnect
end

#rotation_event_inObject

How many days before the rotation of the item would you like to be notified



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

def rotation_event_in
  @rotation_event_in
end

#rotation_hourObject

The Hour of the rotation in UTC



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

def rotation_hour
  @rotation_hour
end

#rotation_intervalObject

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



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

def rotation_interval
  @rotation_interval
end

#secure_access_allow_external_userObject

Allow providing external user for a domain users



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

def secure_access_allow_external_user
  @secure_access_allow_external_user
end

#secure_access_bastion_issuerObject

Path to the SSH Certificate Issuer for your Akeyless Bastion



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

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_enableObject

Enable/Disable secure remote access [true/false]



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

def secure_access_enable
  @secure_access_enable
end

#secure_access_hostObject

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



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

def secure_access_host
  @secure_access_host
end

#secure_access_rdp_domainObject

Default domain name server. i.e. microsoft.com



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

def secure_access_rdp_domain
  @secure_access_rdp_domain
end

#secure_access_rdp_userObject

Override the RDP Domain username



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

def secure_access_rdp_user
  @secure_access_rdp_user
end

#secure_access_ssh_userObject

Override the SSH username as indicated in SSH Certificate Issuer



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

def secure_access_ssh_user
  @secure_access_ssh_user
end

#secure_access_urlObject

Destination URL to inject secrets



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

def secure_access_url
  @secure_access_url
end

#secure_access_webObject

Enable Web Secure Remote Access



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

def secure_access_web
  @secure_access_web
end

#secure_access_web_browsingObject

Secure browser via Akeyless Web Access Bastion



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

def secure_access_web_browsing
  @secure_access_web_browsing
end

#secure_access_web_proxyObject

Web-Proxy via Akeyless Web Access Bastion



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

def secure_access_web_proxy
  @secure_access_web_proxy
end

#tagsObject

Add tags attached to this object



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

def tags
  @tags
end

#target_nameObject

Target name



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

def target_name
  @target_name
end

#timeout_secObject

Maximum allowed time in seconds for the custom rotator to return the results



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

def timeout_sec
  @timeout_sec
end

#tokenObject

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



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

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



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

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



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

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_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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/rotated_secret_create_custom.rb', line 109

def self.attribute_map
  {
    :'authentication_credentials' => :'authentication-credentials',
    :'auto_rotate' => :'auto-rotate',
    :'custom_payload' => :'custom-payload',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'json' => :'json',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'password_length' => :'password-length',
    :'rotate_after_disconnect' => :'rotate-after-disconnect',
    :'rotation_event_in' => :'rotation-event-in',
    :'rotation_hour' => :'rotation-hour',
    :'rotation_interval' => :'rotation-interval',
    :'secure_access_allow_external_user' => :'secure-access-allow-external-user',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'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_ssh_user' => :'secure-access-ssh-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',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'timeout_sec' => :'timeout-sec',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 430

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_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

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/rotated_secret_create_custom.rb', line 150

def self.openapi_types
  {
    :'authentication_credentials' => :'String',
    :'auto_rotate' => :'String',
    :'custom_payload' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'password_length' => :'String',
    :'rotate_after_disconnect' => :'String',
    :'rotation_event_in' => :'Array<String>',
    :'rotation_hour' => :'Integer',
    :'rotation_interval' => :'String',
    :'secure_access_allow_external_user' => :'Boolean',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_enable' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rdp_domain' => :'String',
    :'secure_access_rdp_user' => :'String',
    :'secure_access_ssh_user' => :'String',
    :'secure_access_url' => :'String',
    :'secure_access_web' => :'Boolean',
    :'secure_access_web_browsing' => :'Boolean',
    :'secure_access_web_proxy' => :'Boolean',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'timeout_sec' => :'Integer',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_credentials == o.authentication_credentials &&
      auto_rotate == o.auto_rotate &&
      custom_payload == o.custom_payload &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      json == o.json &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      password_length == o.password_length &&
      rotate_after_disconnect == o.rotate_after_disconnect &&
      rotation_event_in == o.rotation_event_in &&
      rotation_hour == o.rotation_hour &&
      rotation_interval == o.rotation_interval &&
      secure_access_allow_external_user == o.secure_access_allow_external_user &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      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_ssh_user == o.secure_access_ssh_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 &&
      tags == o.tags &&
      target_name == o.target_name &&
      timeout_sec == o.timeout_sec &&
      token == o.token &&
      uid_token == o.uid_token
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



525
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 525

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


417
418
419
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 417

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



423
424
425
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 423

def hash
  [authentication_credentials, auto_rotate, custom_payload, delete_protection, description, json, key, max_versions, name, password_length, rotate_after_disconnect, rotation_event_in, rotation_hour, rotation_interval, secure_access_allow_external_user, secure_access_bastion_issuer, secure_access_enable, secure_access_host, secure_access_rdp_domain, secure_access_rdp_user, secure_access_ssh_user, secure_access_url, secure_access_web, secure_access_web_browsing, secure_access_web_proxy, tags, target_name, timeout_sec, token, uid_token].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 355

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

  if @target_name.nil?
    invalid_properties.push('invalid value for "target_name", target_name cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



501
502
503
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 501

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 507

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



495
496
497
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 495

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



371
372
373
374
375
376
# File 'lib/akeyless/models/rotated_secret_create_custom.rb', line 371

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