Class: Akeyless::CreateKey

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

Overview

createKey is a command that creates a new key. [Deprecated: Use command create-dfc-key]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tag')
    if (value = attributes[:'tag']).is_a?(Array)
      self.tag = value
    end
  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

#alg ⇒ Object

Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096]



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

def alg
  @alg
end

#certificate_common_name ⇒ Object

Common name for the generated certificate. Relevant only for generate-self-signed-certificate.



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

def certificate_common_name
  @certificate_common_name
end

#certificate_country ⇒ Object

Country name for the generated certificate. Relevant only for generate-self-signed-certificate.



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

def certificate_country
  @certificate_country
end

#certificate_digest_algo ⇒ Object

Digest algorithm to be used for the certificate key signing. Currently, we support only "sha256" so we hide this option for CLI.



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

def certificate_digest_algo
  @certificate_digest_algo
end

#certificate_locality ⇒ Object

Locality for the generated certificate. Relevant only for generate-self-signed-certificate.



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

def certificate_locality
  @certificate_locality
end

#certificate_organization ⇒ Object

Organization name for the generated certificate. Relevant only for generate-self-signed-certificate.



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

def certificate_organization
  @certificate_organization
end

#certificate_province ⇒ Object

Province name for the generated certificate. Relevant only for generate-self-signed-certificate.



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

def certificate_province
  @certificate_province
end

#certificate_ttl ⇒ Object

TTL in days for the generated certificate. Required only for generate-self-signed-certificate.



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

def certificate_ttl
  @certificate_ttl
end

#conf_file_data ⇒ Object

The csr config data in base64 encoding



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

def conf_file_data
  @conf_file_data
end

#customer_frg_id ⇒ Object

The customer fragment ID that will be used to create the key (if empty, the key will be created independently of a customer fragment)



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

def customer_frg_id
  @customer_frg_id
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#generate_self_signed_certificate ⇒ Object

Whether to generate a self signed certificate with the key. If set, –certificate-ttl must be provided.



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

def generate_self_signed_certificate
  @generate_self_signed_certificate
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#metadata ⇒ Object

Deprecated - use description



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

def metadata
  @metadata
end

#name ⇒ Object

Key name



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

def name
  @name
end

#split_level ⇒ Object

The number of fragments that the item will be split into (not includes customer fragment)



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

def split_level
  @split_level
end

#tag ⇒ Object

List of the tags attached to this key



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

def tag
  @tag
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/akeyless/models/create_key.rb', line 80

def self.attribute_map
  {
    :'alg' => :'alg',
    :'certificate_common_name' => :'certificate-common-name',
    :'certificate_country' => :'certificate-country',
    :'certificate_digest_algo' => :'certificate-digest-algo',
    :'certificate_locality' => :'certificate-locality',
    :'certificate_organization' => :'certificate-organization',
    :'certificate_province' => :'certificate-province',
    :'certificate_ttl' => :'certificate-ttl',
    :'conf_file_data' => :'conf-file-data',
    :'customer_frg_id' => :'customer-frg-id',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'generate_self_signed_certificate' => :'generate-self-signed-certificate',
    :'json' => :'json',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'split_level' => :'split-level',
    :'tag' => :'tag',
    :'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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/akeyless/models/create_key.rb', line 315

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



137
138
139
140
 
# File 'lib/akeyless/models/create_key.rb', line 137

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

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/akeyless/models/create_key.rb', line 111

def self.openapi_types
  {
    :'alg' => :'String',
    :'certificate_common_name' => :'String',
    :'certificate_country' => :'String',
    :'certificate_digest_algo' => :'String',
    :'certificate_locality' => :'String',
    :'certificate_organization' => :'String',
    :'certificate_province' => :'String',
    :'certificate_ttl' => :'Integer',
    :'conf_file_data' => :'String',
    :'customer_frg_id' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'generate_self_signed_certificate' => :'Boolean',
    :'json' => :'Boolean',
    :'metadata' => :'String',
    :'name' => :'String',
    :'split_level' => :'Integer',
    :'tag' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/akeyless/models/create_key.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      certificate_common_name == o.certificate_common_name &&
      certificate_country == o.certificate_country &&
      certificate_digest_algo == o.certificate_digest_algo &&
      certificate_locality == o.certificate_locality &&
      certificate_organization == o.certificate_organization &&
      certificate_province == o.certificate_province &&
      certificate_ttl == o.certificate_ttl &&
      conf_file_data == o.conf_file_data &&
      customer_frg_id == o.customer_frg_id &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      generate_self_signed_certificate == o.generate_self_signed_certificate &&
      json == o.json &&
      metadata == o.metadata &&
      name == o.name &&
      split_level == o.split_level &&
      tag == o.tag &&
      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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/akeyless/models/create_key.rb', line 410

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


302
303
304
 
# File 'lib/akeyless/models/create_key.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/akeyless/models/create_key.rb', line 308

def hash
  [alg, certificate_common_name, certificate_country, certificate_digest_algo, certificate_locality, certificate_organization, certificate_province, certificate_ttl, conf_file_data, customer_frg_id, delete_protection, description, generate_self_signed_certificate, json, metadata, name, split_level, tag, token, uid_token].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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/akeyless/models/create_key.rb', line 250

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg cannot be nil.')
  end

  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



386
387
388
 
# File 'lib/akeyless/models/create_key.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/akeyless/models/create_key.rb', line 392

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



380
381
382
 
# File 'lib/akeyless/models/create_key.rb', line 380

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



266
267
268
269
270
271
 
# File 'lib/akeyless/models/create_key.rb', line 266

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