Class: Akeyless::AuthMethodCreateK8s

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

Overview

authMethodCreateK8s is a command that creates a new auth method that will be able to authenticate using K8S.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthMethodCreateK8s

Initializes the object

Parameters:

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

    Model attributes in the form of hash



134
135
136
137
138
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
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
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#access_expires ⇒ Object

Access expiration date in Unix timestamp (select 0 for access without expiry date)



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

def access_expires
  @access_expires
end

#audience ⇒ Object

The audience in the Kubernetes JWT that the access is restricted to



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

def audience
  @audience
end

#audit_logs_claims ⇒ Object

Subclaims to include in audit logs, e.g "–audit-logs-claims email –audit-logs-claims username"



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

def audit_logs_claims
  @audit_logs_claims
end

#bound_ips ⇒ Object

A CIDR whitelist with the IPs that the access is restricted to



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

def bound_ips
  @bound_ips
end

#bound_namespaces ⇒ Object

A list of namespaces that the access is restricted to



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

def bound_namespaces
  @bound_namespaces
end

#bound_pod_names ⇒ Object

A list of pod names that the access is restricted to



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

def bound_pod_names
  @bound_pod_names
end

#bound_sa_names ⇒ Object

A list of service account names that the access is restricted to



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

def bound_sa_names
  @bound_sa_names
end

#description ⇒ Object

Auth Method description



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

def description
  @description
end

#force_sub_claims ⇒ Object

if true: enforce role-association must include sub claims



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

def force_sub_claims
  @force_sub_claims
end

#gen_key ⇒ Object

Automatically generate key-pair for K8S configuration. If set to false, a public key needs to be provided [true/false]



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

def gen_key
  @gen_key
end

#gw_bound_ips ⇒ Object

A CIDR whitelist with the GW IPs that the access is restricted to



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

def gw_bound_ips
  @gw_bound_ips
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#jwt_ttl ⇒ Object

Jwt TTL



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

def jwt_ttl
  @jwt_ttl
end

#name ⇒ Object

Auth Method name



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

def name
  @name
end

#product_type ⇒ Object

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]



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

def product_type
  @product_type
end

#public_key ⇒ Object

Base64-encoded or PEM formatted public key data for K8S authentication method is required [RSA2048]



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

def public_key
  @public_key
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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
358
359
360
361
362
363
364
365
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 328

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 74

def self.attribute_map
  {
    :'access_expires' => :'access-expires',
    :'audience' => :'audience',
    :'audit_logs_claims' => :'audit-logs-claims',
    :'bound_ips' => :'bound-ips',
    :'bound_namespaces' => :'bound-namespaces',
    :'bound_pod_names' => :'bound-pod-names',
    :'bound_sa_names' => :'bound-sa-names',
    :'description' => :'description',
    :'force_sub_claims' => :'force-sub-claims',
    :'gen_key' => :'gen-key',
    :'gw_bound_ips' => :'gw-bound-ips',
    :'json' => :'json',
    :'jwt_ttl' => :'jwt-ttl',
    :'name' => :'name',
    :'product_type' => :'product-type',
    :'public_key' => :'public-key',
    :'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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 304

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



127
128
129
130
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 103

def self.openapi_types
  {
    :'access_expires' => :'Integer',
    :'audience' => :'String',
    :'audit_logs_claims' => :'Array<String>',
    :'bound_ips' => :'Array<String>',
    :'bound_namespaces' => :'Array<String>',
    :'bound_pod_names' => :'Array<String>',
    :'bound_sa_names' => :'Array<String>',
    :'description' => :'String',
    :'force_sub_claims' => :'Boolean',
    :'gen_key' => :'String',
    :'gw_bound_ips' => :'Array<String>',
    :'json' => :'Boolean',
    :'jwt_ttl' => :'Integer',
    :'name' => :'String',
    :'product_type' => :'Array<String>',
    :'public_key' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_expires == o.access_expires &&
      audience == o.audience &&
      audit_logs_claims == o.audit_logs_claims &&
      bound_ips == o.bound_ips &&
      bound_namespaces == o.bound_namespaces &&
      bound_pod_names == o.bound_pod_names &&
      bound_sa_names == o.bound_sa_names &&
      description == o.description &&
      force_sub_claims == o.force_sub_claims &&
      gen_key == o.gen_key &&
      gw_bound_ips == o.gw_bound_ips &&
      json == o.json &&
      jwt_ttl == o.jwt_ttl &&
      name == o.name &&
      product_type == o.product_type &&
      public_key == o.public_key &&
      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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 399

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


291
292
293
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 297

def hash
  [access_expires, audience, audit_logs_claims, bound_ips, bound_namespaces, bound_pod_names, bound_sa_names, description, force_sub_claims, gen_key, gw_bound_ips, json, jwt_ttl, name, product_type, public_key, 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



246
247
248
249
250
251
252
253
254
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 246

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



375
376
377
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 381

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



369
370
371
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 369

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



258
259
260
261
262
 
# File 'lib/akeyless/models/auth_method_create_k8s.rb', line 258

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