Class: Akeyless::CreateSSHCertIssuer

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSSHCertIssuer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_users ⇒ Object

Users allowed to fetch the certificate, e.g root,ubuntu



21
22
23
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 21

def allowed_users
  @allowed_users
end

#delete_protection ⇒ Object

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



24
25
26
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 24

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



27
28
29
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 27

def description
  @description
end

#extensions ⇒ Object

Signed certificates with extensions, e.g permit-port-forwarding=\"\"



30
31
32
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 30

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



33
34
35
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 33

def host_provider
  @host_provider
end

#json ⇒ Object

Set output format to JSON



36
37
38
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 36

def json
  @json
end

#metadata ⇒ Object

Deprecated - use description



39
40
41
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 39

def metadata
  @metadata
end

#name ⇒ Object

SSH certificate issuer name



42
43
44
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 42

def name
  @name
end

#principals ⇒ Object

Signed certificates with principal, e.g example_role1,example_role2



45
46
47
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 45

def principals
  @principals
end

#provider_type ⇒ Object

Returns the value of attribute provider_type.



18
19
20
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 18

def provider_type
  @provider_type
end

#secure_access_bastion_api ⇒ Object

Bastion’s SSH control API endpoint. E.g. my.bastion:9900



48
49
50
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 48

def secure_access_bastion_api
  @secure_access_bastion_api
end

#secure_access_bastion_ssh ⇒ Object

Bastion’s SSH server. E.g. my.bastion:22



51
52
53
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 51

def secure_access_bastion_ssh
  @secure_access_bastion_ssh
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



54
55
56
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 54

def secure_access_enable
  @secure_access_enable
end

#secure_access_enforce_hosts_restriction ⇒ Object

Enable this flag to enforce connections only to the hosts listed in –secure-access-host



57
58
59
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 57

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



60
61
62
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 60

def secure_access_host
  @secure_access_host
end

#secure_access_ssh_creds_user ⇒ Object

SSH username to connect to target server, must be in ‘Allowed Users’ list



63
64
65
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 63

def secure_access_ssh_creds_user
  @secure_access_ssh_creds_user
end

#secure_access_use_internal_bastion ⇒ Object

Use internal SSH Bastion



66
67
68
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 66

def secure_access_use_internal_bastion
  @secure_access_use_internal_bastion
end

#signer_key_name ⇒ Object

A key to sign the certificate with



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

def signer_key_name
  @signer_key_name
end

#tag ⇒ Object

List of the tags attached to this key



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

def tag
  @tag
end

#target ⇒ Object

A list of linked targets to be associated, Relevant only for Secure Remote Access for ssh cert issuer, ldap rotated secret and ldap dynamic secret, To specify multiple targets use argument multiple times



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

def target
  @target
end

#token ⇒ Object

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



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

def token
  @token
end

#ttl ⇒ Object

The requested Time To Live for the certificate, in seconds



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

def ttl
  @ttl
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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

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



116
117
118
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 87

def self.attribute_map
  {
    :'provider_type' => :'ProviderType',
    :'allowed_users' => :'allowed-users',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'extensions' => :'extensions',
    :'host_provider' => :'host-provider',
    :'json' => :'json',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'principals' => :'principals',
    :'secure_access_bastion_api' => :'secure-access-bastion-api',
    :'secure_access_bastion_ssh' => :'secure-access-bastion-ssh',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_enforce_hosts_restriction' => :'secure-access-enforce-hosts-restriction',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_ssh_creds_user' => :'secure-access-ssh-creds-user',
    :'secure_access_use_internal_bastion' => :'secure-access-use-internal-bastion',
    :'signer_key_name' => :'signer-key-name',
    :'tag' => :'tag',
    :'target' => :'target',
    :'token' => :'token',
    :'ttl' => :'ttl',
    :'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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 361

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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
146
147
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 121

def self.openapi_types
  {
    :'provider_type' => :'String',
    :'allowed_users' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'extensions' => :'Hash<String, String>',
    :'host_provider' => :'String',
    :'json' => :'Boolean',
    :'metadata' => :'String',
    :'name' => :'String',
    :'principals' => :'String',
    :'secure_access_bastion_api' => :'String',
    :'secure_access_bastion_ssh' => :'String',
    :'secure_access_enable' => :'String',
    :'secure_access_enforce_hosts_restriction' => :'Boolean',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_ssh_creds_user' => :'String',
    :'secure_access_use_internal_bastion' => :'Boolean',
    :'signer_key_name' => :'String',
    :'tag' => :'Array<String>',
    :'target' => :'Array<String>',
    :'token' => :'String',
    :'ttl' => :'Integer',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      provider_type == o.provider_type &&
      allowed_users == o.allowed_users &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      extensions == o.extensions &&
      host_provider == o.host_provider &&
      json == o.json &&
      metadata == o.metadata &&
      name == o.name &&
      principals == o.principals &&
      secure_access_bastion_api == o.secure_access_bastion_api &&
      secure_access_bastion_ssh == o.secure_access_bastion_ssh &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_enforce_hosts_restriction == o.secure_access_enforce_hosts_restriction &&
      secure_access_host == o.secure_access_host &&
      secure_access_ssh_creds_user == o.secure_access_ssh_creds_user &&
      secure_access_use_internal_bastion == o.secure_access_use_internal_bastion &&
      signer_key_name == o.signer_key_name &&
      tag == o.tag &&
      target == o.target &&
      token == o.token &&
      ttl == o.ttl &&
      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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 456

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


348
349
350
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



354
355
356
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 354

def hash
  [provider_type, allowed_users, delete_protection, description, extensions, host_provider, json, metadata, name, principals, secure_access_bastion_api, secure_access_bastion_ssh, secure_access_enable, secure_access_enforce_hosts_restriction, secure_access_host, secure_access_ssh_creds_user, secure_access_use_internal_bastion, signer_key_name, tag, target, token, ttl, 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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 283

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

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

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

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



432
433
434
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 438

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



426
427
428
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 426

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



307
308
309
310
311
312
313
314
 
# File 'lib/akeyless/models/create_ssh_cert_issuer.rb', line 307

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