Class: Akeyless::K8SAuth

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ K8SAuth

Initializes the object

Parameters:

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

    Model attributes in the form of hash



130
131
132
133
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
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#am_token_expiration ⇒ Object

AuthMethodTokenExpiration is time in seconds of expiration of the Akeyless Kube Auth Method token



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

def am_token_expiration
  @am_token_expiration
end

#auth_method_access_id ⇒ Object

AuthMethodAccessId of the Kubernetes auth method



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

def auth_method_access_id
  @auth_method_access_id
end

#auth_method_prv_key_pem ⇒ Object

AuthMethodSigningKey is the private key (in base64 of the PEM format) associated with the public key defined in the Kubernetes auth method, that used to sign the internal token for the Akeyless Kubernetes Auth Method



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

def auth_method_prv_key_pem
  @auth_method_prv_key_pem
end

#cluster_api_type ⇒ Object

ClusterApiType defines types of API access to cluster



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

def cluster_api_type
  @cluster_api_type
end

#disable_iss_validation ⇒ Object

DisableISSValidation is optional parameter to disable ISS validation



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

def disable_iss_validation
  @disable_iss_validation
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#k8s_auth_type ⇒ Object

Returns the value of attribute k8s_auth_type.



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

def k8s_auth_type
  @k8s_auth_type
end

#k8s_ca_cert ⇒ Object

K8SCACert is the CA Cert to use to call into the kubernetes API



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

def k8s_ca_cert
  @k8s_ca_cert
end

#k8s_client_cert_data ⇒ Object

K8sClientCertData is the client certificate for k8s client certificate authentication



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

def k8s_client_cert_data
  @k8s_client_cert_data
end

#k8s_client_key_data ⇒ Object

K8sClientKeyData is the client key for k8s client certificate authentication



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

def k8s_client_key_data
  @k8s_client_key_data
end

#k8s_host ⇒ Object

K8SHost is the url string for the kubernetes API



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

def k8s_host
  @k8s_host
end

#k8s_issuer ⇒ Object

K8SIssuer is the claim that specifies who issued the Kubernetes token



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

def k8s_issuer
  @k8s_issuer
end

#k8s_pub_keys_pem ⇒ Object

K8SPublicKeysPEM is the list of public key in PEM format



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

def k8s_pub_keys_pem
  @k8s_pub_keys_pem
end

#k8s_token_reviewer_jwt ⇒ Object

K8STokenReviewerJWT is the bearer for clusterApiTypeK8s, used during TokenReview API call



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

def k8s_token_reviewer_jwt
  @k8s_token_reviewer_jwt
end

#name ⇒ Object

Returns the value of attribute name.



58
59
60
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 58

def name
  @name
end

#rancher_api_key ⇒ Object

RancherApiKey the bear token for clusterApiTypeRancher



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

def rancher_api_key
  @rancher_api_key
end

#rancher_cluster_id ⇒ Object

RancherClusterId cluster id as define in rancher (in case of clusterApiTypeRancher)



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

def rancher_cluster_id
  @rancher_cluster_id
end

#use_local_ca_jwt ⇒ Object

UseLocalCAJwt is an optional parameter to set defaulting to using the local service account when running in a Kubernetes pod



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

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



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

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



94
95
96
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 70

def self.attribute_map
  {
    :'am_token_expiration' => :'am_token_expiration',
    :'auth_method_access_id' => :'auth_method_access_id',
    :'auth_method_prv_key_pem' => :'auth_method_prv_key_pem',
    :'cluster_api_type' => :'cluster_api_type',
    :'disable_iss_validation' => :'disable_iss_validation',
    :'id' => :'id',
    :'k8s_auth_type' => :'k8s_auth_type',
    :'k8s_ca_cert' => :'k8s_ca_cert',
    :'k8s_client_cert_data' => :'k8s_client_cert_data',
    :'k8s_client_key_data' => :'k8s_client_key_data',
    :'k8s_host' => :'k8s_host',
    :'k8s_issuer' => :'k8s_issuer',
    :'k8s_pub_keys_pem' => :'k8s_pub_keys_pem',
    :'k8s_token_reviewer_jwt' => :'k8s_token_reviewer_jwt',
    :'name' => :'name',
    :'rancher_api_key' => :'rancher_api_key',
    :'rancher_cluster_id' => :'rancher_cluster_id',
    :'use_local_ca_jwt' => :'use_local_ca_jwt'
  }
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 273

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



123
124
125
126
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 99

def self.openapi_types
  {
    :'am_token_expiration' => :'Integer',
    :'auth_method_access_id' => :'String',
    :'auth_method_prv_key_pem' => :'String',
    :'cluster_api_type' => :'String',
    :'disable_iss_validation' => :'Boolean',
    :'id' => :'String',
    :'k8s_auth_type' => :'String',
    :'k8s_ca_cert' => :'String',
    :'k8s_client_cert_data' => :'String',
    :'k8s_client_key_data' => :'String',
    :'k8s_host' => :'String',
    :'k8s_issuer' => :'String',
    :'k8s_pub_keys_pem' => :'Array<String>',
    :'k8s_token_reviewer_jwt' => :'String',
    :'name' => :'String',
    :'rancher_api_key' => :'String',
    :'rancher_cluster_id' => :'String',
    :'use_local_ca_jwt' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      am_token_expiration == o.am_token_expiration &&
      auth_method_access_id == o.auth_method_access_id &&
      auth_method_prv_key_pem == o.auth_method_prv_key_pem &&
      cluster_api_type == o.cluster_api_type &&
      disable_iss_validation == o.disable_iss_validation &&
      id == o.id &&
      k8s_auth_type == o.k8s_auth_type &&
      k8s_ca_cert == o.k8s_ca_cert &&
      k8s_client_cert_data == o.k8s_client_cert_data &&
      k8s_client_key_data == o.k8s_client_key_data &&
      k8s_host == o.k8s_host &&
      k8s_issuer == o.k8s_issuer &&
      k8s_pub_keys_pem == o.k8s_pub_keys_pem &&
      k8s_token_reviewer_jwt == o.k8s_token_reviewer_jwt &&
      name == o.name &&
      rancher_api_key == o.rancher_api_key &&
      rancher_cluster_id == o.rancher_cluster_id &&
      use_local_ca_jwt == o.use_local_ca_jwt
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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 368

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


260
261
262
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 266

def hash
  [am_token_expiration, auth_method_access_id, auth_method_prv_key_pem, cluster_api_type, disable_iss_validation, id, k8s_auth_type, k8s_ca_cert, k8s_client_cert_data, k8s_client_key_data, k8s_host, k8s_issuer, k8s_pub_keys_pem, k8s_token_reviewer_jwt, name, rancher_api_key, rancher_cluster_id, use_local_ca_jwt].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



220
221
222
223
224
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 220

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



344
345
346
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 344

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 350

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



338
339
340
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 338

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



228
229
230
231
 
# File 'lib/akeyless/models/k8_s_auth.rb', line 228

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end