Class: Akeyless::Auth

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Auth

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'access_type')
    self.access_type = attributes[:'access_type']
  else
    self.access_type = 'access_key'
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'gcp_audience')
    self.gcp_audience = attributes[:'gcp_audience']
  else
    self.gcp_audience = 'akeyless.io'
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'oci_auth_type')
    self.oci_auth_type = attributes[:'oci_auth_type']
  else
    self.oci_auth_type = 'apikey'
  end

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

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

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

Instance Attribute Details

#access_id ⇒ Object

Access ID



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

def access_id
  @access_id
end

#access_key ⇒ Object

Access key (relevant only for access-type=access_key)



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

def access_key
  @access_key
end

#access_type ⇒ Object

Access Type (access_key/password/saml/ldap/k8s/azure_ad/oidc/aws_iam/universal_identity/jwt/gcp/cert)



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

def access_type
  @access_type
end

#account_id ⇒ Object

Account id (relevant only for access-type=password where the email address is associated with more than one account)



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

def 
  @account_id
end

#admin_email ⇒ Object

Email (relevant only for access-type=password)



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

def admin_email
  @admin_email
end

#admin_password ⇒ Object

Password (relevant only for access-type=password)



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

def admin_password
  @admin_password
end

#cert_data ⇒ Object

Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert)



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

def cert_data
  @cert_data
end

#cloud_id ⇒ Object

The cloud identity (relevant only for access-type=azure_ad,aws_iam,gcp)



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

def cloud_id
  @cloud_id
end

#debug ⇒ Object

Returns the value of attribute debug.



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

def debug
  @debug
end

#disable_pafxfast ⇒ Object

Disable the FAST negotiation in the Kerberos authentication method



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

def disable_pafxfast
  @disable_pafxfast
end

#gateway_spn ⇒ Object

The service principal name of the gateway as registered in LDAP (i.e., HTTP/gateway)



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

def gateway_spn
  @gateway_spn
end

#gateway_url ⇒ Object

Gateway URL relevant only for access-type=k8s/oauth2/saml/oidc



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

def gateway_url
  @gateway_url
end

#gcp_audience ⇒ Object

GCP JWT audience



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

def gcp_audience
  @gcp_audience
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#jwt ⇒ Object

The Json Web Token (relevant only for access-type=jwt/oidc)



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

def jwt
  @jwt
end

#k8s_auth_config_name ⇒ Object

The K8S Auth config name (relevant only for access-type=k8s)



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

def k8s_auth_config_name
  @k8s_auth_config_name
end

#k8s_service_account_token ⇒ Object

The K8S service account token. (relevant only for access-type=k8s)



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

def 
  @k8s_service_account_token
end

#kerberos_username ⇒ Object

TThe username for the entry within the keytab to authenticate via Kerberos



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

def kerberos_username
  @kerberos_username
end

#key_data ⇒ Object

Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert)



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

def key_data
  @key_data
end

#keytab_data ⇒ Object

Base64-encoded content of a valid keytab file, containing the service account’s entry.



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

def keytab_data
  @keytab_data
end

#krb5_conf_data ⇒ Object

Base64-encoded content of a valid krb5.conf file, specifying the settings and parameters required for Kerberos authentication.



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

def krb5_conf_data
  @krb5_conf_data
end

#ldap_password ⇒ Object

LDAP password (relevant only for access-type=ldap)



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

def ldap_password
  @ldap_password
end

#ldap_username ⇒ Object

LDAP username (relevant only for access-type=ldap)



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

def ldap_username
  @ldap_username
end

#oci_auth_type ⇒ Object

The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci)



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

def oci_auth_type
  @oci_auth_type
end

#oci_group_ocid ⇒ Object

A list of Oracle Cloud IDs groups (relevant only for access-type=oci)



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

def oci_group_ocid
  @oci_group_ocid
end

#uid_token ⇒ Object

The universal_identity token (relevant only for access-type=universal_identity)



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

def uid_token
  @uid_token
end

#use_remote_browser ⇒ Object

Returns a link to complete the authentication remotely (relevant only for access-type=saml/oidc)



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

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



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
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/akeyless/models/auth.rb', line 397

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



132
133
134
 
# File 'lib/akeyless/models/auth.rb', line 132

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/akeyless/models/auth.rb', line 99

def self.attribute_map
  {
    :'access_id' => :'access-id',
    :'access_key' => :'access-key',
    :'access_type' => :'access-type',
    :'account_id' => :'account-id',
    :'admin_email' => :'admin-email',
    :'admin_password' => :'admin-password',
    :'cert_data' => :'cert-data',
    :'cloud_id' => :'cloud-id',
    :'debug' => :'debug',
    :'disable_pafxfast' => :'disable-pafxfast',
    :'gateway_spn' => :'gateway-spn',
    :'gateway_url' => :'gateway-url',
    :'gcp_audience' => :'gcp-audience',
    :'json' => :'json',
    :'jwt' => :'jwt',
    :'k8s_auth_config_name' => :'k8s-auth-config-name',
    :'k8s_service_account_token' => :'k8s-service-account-token',
    :'kerberos_username' => :'kerberos-username',
    :'key_data' => :'key-data',
    :'keytab_data' => :'keytab-data',
    :'krb5_conf_data' => :'krb5-conf-data',
    :'ldap_password' => :'ldap_password',
    :'ldap_username' => :'ldap_username',
    :'oci_auth_type' => :'oci-auth-type',
    :'oci_group_ocid' => :'oci-group-ocid',
    :'uid_token' => :'uid_token',
    :'use_remote_browser' => :'use-remote-browser'
  }
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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/akeyless/models/auth.rb', line 373

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



170
171
172
173
 
# File 'lib/akeyless/models/auth.rb', line 170

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'access_id' => :'String',
    :'access_key' => :'String',
    :'access_type' => :'String',
    :'account_id' => :'String',
    :'admin_email' => :'String',
    :'admin_password' => :'String',
    :'cert_data' => :'String',
    :'cloud_id' => :'String',
    :'debug' => :'Boolean',
    :'disable_pafxfast' => :'String',
    :'gateway_spn' => :'String',
    :'gateway_url' => :'String',
    :'gcp_audience' => :'String',
    :'json' => :'Boolean',
    :'jwt' => :'String',
    :'k8s_auth_config_name' => :'String',
    :'k8s_service_account_token' => :'String',
    :'kerberos_username' => :'String',
    :'key_data' => :'String',
    :'keytab_data' => :'String',
    :'krb5_conf_data' => :'String',
    :'ldap_password' => :'String',
    :'ldap_username' => :'String',
    :'oci_auth_type' => :'String',
    :'oci_group_ocid' => :'Array<String>',
    :'uid_token' => :'String',
    :'use_remote_browser' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_id == o.access_id &&
      access_key == o.access_key &&
      access_type == o.access_type &&
       == o. &&
      admin_email == o.admin_email &&
      admin_password == o.admin_password &&
      cert_data == o.cert_data &&
      cloud_id == o.cloud_id &&
      debug == o.debug &&
      disable_pafxfast == o.disable_pafxfast &&
      gateway_spn == o.gateway_spn &&
      gateway_url == o.gateway_url &&
      gcp_audience == o.gcp_audience &&
      json == o.json &&
      jwt == o.jwt &&
      k8s_auth_config_name == o.k8s_auth_config_name &&
       == o. &&
      kerberos_username == o.kerberos_username &&
      key_data == o.key_data &&
      keytab_data == o.keytab_data &&
      krb5_conf_data == o.krb5_conf_data &&
      ldap_password == o.ldap_password &&
      ldap_username == o.ldap_username &&
      oci_auth_type == o.oci_auth_type &&
      oci_group_ocid == o.oci_group_ocid &&
      uid_token == o.uid_token &&
      use_remote_browser == o.use_remote_browser
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



468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/akeyless/models/auth.rb', line 468

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


360
361
362
 
# File 'lib/akeyless/models/auth.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



366
367
368
 
# File 'lib/akeyless/models/auth.rb', line 366

def hash
  [access_id, access_key, access_type, , admin_email, admin_password, cert_data, cloud_id, debug, disable_pafxfast, gateway_spn, gateway_url, gcp_audience, json, jwt, k8s_auth_config_name, , kerberos_username, key_data, keytab_data, krb5_conf_data, ldap_password, ldap_username, oci_auth_type, oci_group_ocid, uid_token, use_remote_browser].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



311
312
313
314
315
 
# File 'lib/akeyless/models/auth.rb', line 311

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



444
445
446
 
# File 'lib/akeyless/models/auth.rb', line 444

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/akeyless/models/auth.rb', line 450

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



438
439
440
 
# File 'lib/akeyless/models/auth.rb', line 438

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



319
320
321
322
 
# File 'lib/akeyless/models/auth.rb', line 319

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