Class: Akeyless::CreateSecret

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSecret

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
352
353
354
355
356
357
 
# File 'lib/akeyless/models/create_secret.rb', line 197

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

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

  if attributes.key?(:'custom_field')
    if (value = attributes[:'custom_field']).is_a?(Hash)
      self.custom_field = value
    end
  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?(:'format')
    self.format = attributes[:'format']
  else
    self.format = 'text'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accessibility ⇒ Object

for personal password manager



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

def accessibility
  @accessibility
end

#change_event ⇒ Object

Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret)



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

def change_event
  @change_event
end

#custom_field ⇒ Object

For Password Management use, additional fields



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

def custom_field
  @custom_field
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#format ⇒ Object

Secret format [text/json/key-value] (relevant only for type ‘generic’)



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

def format
  @format
end

#inject_url ⇒ Object

For Password Management use, reflect the website context



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

def inject_url
  @inject_url
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#max_versions ⇒ Object

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



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

def max_versions
  @max_versions
end

#metadata ⇒ Object

Deprecated - use description



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

def metadata
  @metadata
end

#multiline_value ⇒ Object

The provided value is a multiline value (separated by ‘\n’)



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

def multiline_value
  @multiline_value
end

#name ⇒ Object

Secret name



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

def name
  @name
end

#password ⇒ Object

For Password Management use, additional fields



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

def password
  @password
end

#protection_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/create_secret.rb', line 58

def protection_key
  @protection_key
end

#secure_access_bastion_issuer ⇒ Object

Deprecated. use secure-access-certificate-issuer



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

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_certificate_issuer ⇒ Object

Path to the SSH Certificate Issuer for your Akeyless Secure Access



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

def secure_access_certificate_issuer
  @secure_access_certificate_issuer
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



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

def secure_access_enable
  @secure_access_enable
end

#secure_access_gateway ⇒ Object

Returns the value of attribute secure_access_gateway.



69
70
71
 
# File 'lib/akeyless/models/create_secret.rb', line 69

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



72
73
74
 
# File 'lib/akeyless/models/create_secret.rb', line 72

def secure_access_host
  @secure_access_host
end

#secure_access_rdp_user ⇒ Object

Remote Desktop Username



75
76
77
 
# File 'lib/akeyless/models/create_secret.rb', line 75

def secure_access_rdp_user
  @secure_access_rdp_user
end

#secure_access_ssh_creds ⇒ Object

Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]



78
79
80
 
# File 'lib/akeyless/models/create_secret.rb', line 78

def secure_access_ssh_creds
  @secure_access_ssh_creds
end

#secure_access_ssh_user ⇒ Object

Override the SSH username as indicated in SSH Certificate Issuer



81
82
83
 
# File 'lib/akeyless/models/create_secret.rb', line 81

def secure_access_ssh_user
  @secure_access_ssh_user
end

#secure_access_url ⇒ Object

Destination URL to inject secrets



84
85
86
 
# File 'lib/akeyless/models/create_secret.rb', line 84

def secure_access_url
  @secure_access_url
end

#secure_access_web_browsing ⇒ Object

Secure browser via Akeyless’s Secure Remote Access (SRA)



87
88
89
 
# File 'lib/akeyless/models/create_secret.rb', line 87

def secure_access_web_browsing
  @secure_access_web_browsing
end

#secure_access_web_proxy ⇒ Object

Web-Proxy via Akeyless’s Secure Remote Access (SRA)



90
91
92
 
# File 'lib/akeyless/models/create_secret.rb', line 90

def secure_access_web_proxy
  @secure_access_web_proxy
end

#tags ⇒ Object

Add tags attached to this object



93
94
95
 
# File 'lib/akeyless/models/create_secret.rb', line 93

def tags
  @tags
end

#token ⇒ Object

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



96
97
98
 
# File 'lib/akeyless/models/create_secret.rb', line 96

def token
  @token
end

#type ⇒ Object

The secret sub type [generic/password]



99
100
101
 
# File 'lib/akeyless/models/create_secret.rb', line 99

def type
  @type
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



102
103
104
 
# File 'lib/akeyless/models/create_secret.rb', line 102

def uid_token
  @uid_token
end

#username ⇒ Object

For Password Management use



105
106
107
 
# File 'lib/akeyless/models/create_secret.rb', line 105

def username
  @username
end

#value ⇒ Object

The secret value (relevant only for type ‘generic’)



108
109
110
 
# File 'lib/akeyless/models/create_secret.rb', line 108

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
143
144
145
 
# File 'lib/akeyless/models/create_secret.rb', line 111

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'change_event' => :'change-event',
    :'custom_field' => :'custom-field',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'format' => :'format',
    :'inject_url' => :'inject-url',
    :'json' => :'json',
    :'max_versions' => :'max-versions',
    :'metadata' => :'metadata',
    :'multiline_value' => :'multiline_value',
    :'name' => :'name',
    :'password' => :'password',
    :'protection_key' => :'protection_key',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_certificate_issuer' => :'secure-access-certificate-issuer',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_gateway' => :'secure-access-gateway',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_rdp_user' => :'secure-access-rdp-user',
    :'secure_access_ssh_creds' => :'secure-access-ssh-creds',
    :'secure_access_ssh_user' => :'secure-access-ssh-user',
    :'secure_access_url' => :'secure-access-url',
    :'secure_access_web_browsing' => :'secure-access-web-browsing',
    :'secure_access_web_proxy' => :'secure-access-web-proxy',
    :'tags' => :'tags',
    :'token' => :'token',
    :'type' => :'type',
    :'uid_token' => :'uid-token',
    :'username' => :'username',
    :'value' => :'value'
  }
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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/akeyless/models/create_secret.rb', line 437

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



190
191
192
193
 
# File 'lib/akeyless/models/create_secret.rb', line 190

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

.openapi_types ⇒ Object

Attribute type mapping.



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
184
185
186
187
 
# File 'lib/akeyless/models/create_secret.rb', line 153

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'change_event' => :'String',
    :'custom_field' => :'Hash<String, String>',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'format' => :'String',
    :'inject_url' => :'Array<String>',
    :'json' => :'Boolean',
    :'max_versions' => :'String',
    :'metadata' => :'String',
    :'multiline_value' => :'Boolean',
    :'name' => :'String',
    :'password' => :'String',
    :'protection_key' => :'String',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_certificate_issuer' => :'String',
    :'secure_access_enable' => :'String',
    :'secure_access_gateway' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rdp_user' => :'String',
    :'secure_access_ssh_creds' => :'String',
    :'secure_access_ssh_user' => :'String',
    :'secure_access_url' => :'String',
    :'secure_access_web_browsing' => :'Boolean',
    :'secure_access_web_proxy' => :'Boolean',
    :'tags' => :'Array<String>',
    :'token' => :'String',
    :'type' => :'String',
    :'uid_token' => :'String',
    :'username' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      change_event == o.change_event &&
      custom_field == o.custom_field &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      format == o.format &&
      inject_url == o.inject_url &&
      json == o.json &&
      max_versions == o.max_versions &&
      metadata == o.metadata &&
      multiline_value == o.multiline_value &&
      name == o.name &&
      password == o.password &&
      protection_key == o.protection_key &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      secure_access_certificate_issuer == o.secure_access_certificate_issuer &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_gateway == o.secure_access_gateway &&
      secure_access_host == o.secure_access_host &&
      secure_access_rdp_user == o.secure_access_rdp_user &&
      secure_access_ssh_creds == o.secure_access_ssh_creds &&
      secure_access_ssh_user == o.secure_access_ssh_user &&
      secure_access_url == o.secure_access_url &&
      secure_access_web_browsing == o.secure_access_web_browsing &&
      secure_access_web_proxy == o.secure_access_web_proxy &&
      tags == o.tags &&
      token == o.token &&
      type == o.type &&
      uid_token == o.uid_token &&
      username == o.username &&
      value == o.value
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



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/akeyless/models/create_secret.rb', line 532

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


424
425
426
 
# File 'lib/akeyless/models/create_secret.rb', line 424

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



430
431
432
 
# File 'lib/akeyless/models/create_secret.rb', line 430

def hash
  [accessibility, change_event, custom_field, delete_protection, description, format, inject_url, json, max_versions, metadata, multiline_value, name, password, protection_key, secure_access_bastion_issuer, secure_access_certificate_issuer, secure_access_enable, secure_access_gateway, secure_access_host, secure_access_rdp_user, secure_access_ssh_creds, secure_access_ssh_user, secure_access_url, secure_access_web_browsing, secure_access_web_proxy, tags, token, type, uid_token, username, value].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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/akeyless/models/create_secret.rb', line 361

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 @value.nil?
    invalid_properties.push('invalid value for "value", value 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



508
509
510
 
# File 'lib/akeyless/models/create_secret.rb', line 508

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



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/akeyless/models/create_secret.rb', line 514

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



502
503
504
 
# File 'lib/akeyless/models/create_secret.rb', line 502

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



377
378
379
380
381
382
 
# File 'lib/akeyless/models/create_secret.rb', line 377

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