Class: Akeyless::DynamicSecretUpdateVenafi

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

Overview

dynamicSecretUpdateVenafi is a command that updates a Venafi dynamic secret to dynamically update certificates generated by Venafi or have Akeyless generated certificates using PKI be monitored by Venafi

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicSecretUpdateVenafi

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'store_private_key')
    self.store_private_key = attributes[:'store_private_key']
  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']
  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_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '2160h'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#admin_rotation_interval_days ⇒ Object

Admin credentials rotation interval (days)



20
21
22
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 20

def admin_rotation_interval_days
  @admin_rotation_interval_days
end

#allow_subdomains ⇒ Object

Allow subdomains



23
24
25
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 23

def allow_subdomains
  @allow_subdomains
end

#allowed_domains ⇒ Object

Allowed domains



26
27
28
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 26

def allowed_domains
  @allowed_domains
end

#auto_generated_folder ⇒ Object

Auto generated folder



29
30
31
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 29

def auto_generated_folder
  @auto_generated_folder
end

#delete_protection ⇒ Object

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



32
33
34
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 32

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



35
36
37
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 35

def description
  @description
end

#enable_admin_rotation ⇒ Object

Automatic admin credentials rotation



38
39
40
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 38

def enable_admin_rotation
  @enable_admin_rotation
end

#json ⇒ Object

Set output format to JSON



41
42
43
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 41

def json
  @json
end

#name ⇒ Object

Dynamic secret name



44
45
46
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 44

def name
  @name
end

#new_name ⇒ Object

Dynamic secret new name



47
48
49
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 47

def new_name
  @new_name
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



50
51
52
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 50

def producer_encryption_key_name
  @producer_encryption_key_name
end

#root_first_in_chain ⇒ Object

Root first in chain



53
54
55
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 53

def root_first_in_chain
  @root_first_in_chain
end

#sign_using_akeyless_pki ⇒ Object

Use Akeyless PKI issuer or Venafi issuer



56
57
58
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 56

def sign_using_akeyless_pki
  @sign_using_akeyless_pki
end

#signer_key_name ⇒ Object

Signer key name



59
60
61
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 59

def signer_key_name
  @signer_key_name
end

#store_private_key ⇒ Object

Store private key



62
63
64
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 62

def store_private_key
  @store_private_key
end

#tags ⇒ Object

Add tags attached to this object



65
66
67
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 65

def tags
  @tags
end

#target_name ⇒ Object

Target name



68
69
70
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 68

def target_name
  @target_name
end

#token ⇒ Object

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



71
72
73
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 71

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



74
75
76
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 74

def uid_token
  @uid_token
end

#user_ttl ⇒ Object

User TTL in time.Duration format (2160h / 129600m / etc…). When using sign-using-akeyless-pki certificates created will have this validity period, otherwise the user-ttl is taken from the Validity Period field of the Zone’s’ Issuing Template. When using cert-manager it is advised to have a TTL of above 60 days (1440h). For more information - cert-manager.io/docs/usage/certificate/



77
78
79
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 77

def user_ttl
  @user_ttl
end

#venafi_access_token ⇒ Object

Venafi Access Token to use to access the TPP environment (Relevant when using TPP)



80
81
82
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 80

def venafi_access_token
  @venafi_access_token
end

#venafi_api_key ⇒ Object

Venafi API key



83
84
85
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 83

def venafi_api_key
  @venafi_api_key
end

#venafi_baseurl ⇒ Object

Venafi Baseurl



86
87
88
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 86

def venafi_baseurl
  @venafi_baseurl
end

#venafi_client_id ⇒ Object

Venafi Client ID that was used when the access token was generated



89
90
91
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 89

def venafi_client_id
  @venafi_client_id
end

#venafi_refresh_token ⇒ Object

Venafi Refresh Token to use when the Access Token is expired (Relevant when using TPP)



92
93
94
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 92

def venafi_refresh_token
  @venafi_refresh_token
end

#venafi_use_tpp ⇒ Object

Venafi using TPP



95
96
97
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 95

def venafi_use_tpp
  @venafi_use_tpp
end

#venafi_zone ⇒ Object

Venafi Zone



98
99
100
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 98

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



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

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



134
135
136
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 134

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 101

def self.attribute_map
  {
    :'admin_rotation_interval_days' => :'admin-rotation-interval-days',
    :'allow_subdomains' => :'allow-subdomains',
    :'allowed_domains' => :'allowed-domains',
    :'auto_generated_folder' => :'auto-generated-folder',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'enable_admin_rotation' => :'enable-admin-rotation',
    :'json' => :'json',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'root_first_in_chain' => :'root-first-in-chain',
    :'sign_using_akeyless_pki' => :'sign-using-akeyless-pki',
    :'signer_key_name' => :'signer-key-name',
    :'store_private_key' => :'store-private-key',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_ttl' => :'user-ttl',
    :'venafi_access_token' => :'venafi-access-token',
    :'venafi_api_key' => :'venafi-api-key',
    :'venafi_baseurl' => :'venafi-baseurl',
    :'venafi_client_id' => :'venafi-client-id',
    :'venafi_refresh_token' => :'venafi-refresh-token',
    :'venafi_use_tpp' => :'venafi-use-tpp',
    :'venafi_zone' => :'venafi-zone'
  }
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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 386

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



172
173
174
175
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 172

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

.openapi_types ⇒ Object

Attribute type mapping.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 139

def self.openapi_types
  {
    :'admin_rotation_interval_days' => :'Integer',
    :'allow_subdomains' => :'Boolean',
    :'allowed_domains' => :'Array<String>',
    :'auto_generated_folder' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'enable_admin_rotation' => :'Boolean',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'new_name' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'root_first_in_chain' => :'Boolean',
    :'sign_using_akeyless_pki' => :'Boolean',
    :'signer_key_name' => :'String',
    :'store_private_key' => :'Boolean',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_ttl' => :'String',
    :'venafi_access_token' => :'String',
    :'venafi_api_key' => :'String',
    :'venafi_baseurl' => :'String',
    :'venafi_client_id' => :'String',
    :'venafi_refresh_token' => :'String',
    :'venafi_use_tpp' => :'Boolean',
    :'venafi_zone' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      admin_rotation_interval_days == o.admin_rotation_interval_days &&
      allow_subdomains == o.allow_subdomains &&
      allowed_domains == o.allowed_domains &&
      auto_generated_folder == o.auto_generated_folder &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      enable_admin_rotation == o.enable_admin_rotation &&
      json == o.json &&
      name == o.name &&
      new_name == o.new_name &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      root_first_in_chain == o.root_first_in_chain &&
      sign_using_akeyless_pki == o.sign_using_akeyless_pki &&
      signer_key_name == o.signer_key_name &&
      store_private_key == o.store_private_key &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_ttl == o.user_ttl &&
      venafi_access_token == o.venafi_access_token &&
      venafi_api_key == o.venafi_api_key &&
      venafi_baseurl == o.venafi_baseurl &&
      venafi_client_id == o.venafi_client_id &&
      venafi_refresh_token == o.venafi_refresh_token &&
      venafi_use_tpp == o.venafi_use_tpp &&
      venafi_zone == o.venafi_zone
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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 481

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


373
374
375
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 373

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



379
380
381
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 379

def hash
  [admin_rotation_interval_days, allow_subdomains, allowed_domains, auto_generated_folder, delete_protection, description, enable_admin_rotation, json, name, new_name, producer_encryption_key_name, root_first_in_chain, sign_using_akeyless_pki, signer_key_name, store_private_key, tags, target_name, token, uid_token, user_ttl, venafi_access_token, venafi_api_key, venafi_baseurl, venafi_client_id, venafi_refresh_token, venafi_use_tpp, venafi_zone].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



319
320
321
322
323
324
325
326
327
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 319

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



457
458
459
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 457

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



463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 463

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



451
452
453
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 451

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



331
332
333
334
335
 
# File 'lib/akeyless/models/dynamic_secret_update_venafi.rb', line 331

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