Class: Akeyless::AuthMethodCreateKerberos

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

Overview

authMethodCreateKerberos is a command that creates a new auth method that will be able to authenticate using Kerberos

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthMethodCreateKerberos

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 175

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'user_dn')
    self.user_dn = attributes[:'user_dn']
  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_kerberos.rb', line 20

def access_expires
  @access_expires
end

#audit_logs_claims ⇒ Object

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



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

def audit_logs_claims
  @audit_logs_claims
end

#bind_dn ⇒ Object

Returns the value of attribute bind_dn.



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

def bind_dn
  @bind_dn
end

#bind_dn_password ⇒ Object

Returns the value of attribute bind_dn_password.



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

def bind_dn_password
  @bind_dn_password
end

#bound_ips ⇒ Object

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



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

def bound_ips
  @bound_ips
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Auth Method description



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

def description
  @description
end

#force_sub_claims ⇒ Object

if true: enforce role-association must include sub claims



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

def force_sub_claims
  @force_sub_claims
end

#group_attr ⇒ Object

Returns the value of attribute group_attr.



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

def group_attr
  @group_attr
end

#group_dn ⇒ Object

Returns the value of attribute group_dn.



43
44
45
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 43

def group_dn
  @group_dn
end

#group_filter ⇒ Object

Returns the value of attribute group_filter.



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

def group_filter
  @group_filter
end

#gw_bound_ips ⇒ Object

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



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

def gw_bound_ips
  @gw_bound_ips
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#jwt_ttl ⇒ Object

Jwt TTL



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

def jwt_ttl
  @jwt_ttl
end

#keytab_file_data ⇒ Object

Returns the value of attribute keytab_file_data.



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

def keytab_file_data
  @keytab_file_data
end

#keytab_file_path ⇒ Object

Returns the value of attribute keytab_file_path.



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

def keytab_file_path
  @keytab_file_path
end

#krb5_conf_data ⇒ Object

Returns the value of attribute krb5_conf_data.



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

def krb5_conf_data
  @krb5_conf_data
end

#krb5_conf_path ⇒ Object

Returns the value of attribute krb5_conf_path.



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

def krb5_conf_path
  @krb5_conf_path
end

#ldap_anonymous_search ⇒ Object

Returns the value of attribute ldap_anonymous_search.



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

def ldap_anonymous_search
  @ldap_anonymous_search
end

#ldap_ca_cert ⇒ Object

Returns the value of attribute ldap_ca_cert.



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

def ldap_ca_cert
  @ldap_ca_cert
end

#ldap_url ⇒ Object

Returns the value of attribute ldap_url.



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

def ldap_url
  @ldap_url
end

#name ⇒ Object

Auth Method name



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

def name
  @name
end

#product_type ⇒ Object

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



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

def product_type
  @product_type
end

#subclaims_delimiters ⇒ Object

A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)



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

def subclaims_delimiters
  @subclaims_delimiters
end

#token ⇒ Object

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



80
81
82
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 80

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



83
84
85
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 83

def uid_token
  @uid_token
end

#unique_identifier ⇒ Object

A unique identifier (ID) value which is a "sub claim" name that contains details uniquely identifying that resource. This "sub claim" is used to distinguish between different identities.



86
87
88
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 86

def unique_identifier
  @unique_identifier
end

#user_attribute ⇒ Object

Returns the value of attribute user_attribute.



88
89
90
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 88

def user_attribute
  @user_attribute
end

#user_dn ⇒ Object

Returns the value of attribute user_dn.



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

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 418

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
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
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 93

def self.attribute_map
  {
    :'access_expires' => :'access-expires',
    :'audit_logs_claims' => :'audit-logs-claims',
    :'bind_dn' => :'bind-dn',
    :'bind_dn_password' => :'bind-dn-password',
    :'bound_ips' => :'bound-ips',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'force_sub_claims' => :'force-sub-claims',
    :'group_attr' => :'group-attr',
    :'group_dn' => :'group-dn',
    :'group_filter' => :'group-filter',
    :'gw_bound_ips' => :'gw-bound-ips',
    :'json' => :'json',
    :'jwt_ttl' => :'jwt-ttl',
    :'keytab_file_data' => :'keytab-file-data',
    :'keytab_file_path' => :'keytab-file-path',
    :'krb5_conf_data' => :'krb5-conf-data',
    :'krb5_conf_path' => :'krb5-conf-path',
    :'ldap_anonymous_search' => :'ldap-anonymous-search',
    :'ldap_ca_cert' => :'ldap-ca-cert',
    :'ldap_url' => :'ldap-url',
    :'name' => :'name',
    :'product_type' => :'product-type',
    :'subclaims_delimiters' => :'subclaims-delimiters',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'unique_identifier' => :'unique-identifier',
    :'user_attribute' => :'user-attribute',
    :'user_dn' => :'user-dn'
  }
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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 394

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



168
169
170
171
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 168

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'access_expires' => :'Integer',
    :'audit_logs_claims' => :'Array<String>',
    :'bind_dn' => :'String',
    :'bind_dn_password' => :'String',
    :'bound_ips' => :'Array<String>',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'force_sub_claims' => :'Boolean',
    :'group_attr' => :'String',
    :'group_dn' => :'String',
    :'group_filter' => :'String',
    :'gw_bound_ips' => :'Array<String>',
    :'json' => :'Boolean',
    :'jwt_ttl' => :'Integer',
    :'keytab_file_data' => :'String',
    :'keytab_file_path' => :'String',
    :'krb5_conf_data' => :'String',
    :'krb5_conf_path' => :'String',
    :'ldap_anonymous_search' => :'Boolean',
    :'ldap_ca_cert' => :'String',
    :'ldap_url' => :'String',
    :'name' => :'String',
    :'product_type' => :'Array<String>',
    :'subclaims_delimiters' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'unique_identifier' => :'String',
    :'user_attribute' => :'String',
    :'user_dn' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
377
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 345

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_expires == o.access_expires &&
      audit_logs_claims == o.audit_logs_claims &&
      bind_dn == o.bind_dn &&
      bind_dn_password == o.bind_dn_password &&
      bound_ips == o.bound_ips &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      force_sub_claims == o.force_sub_claims &&
      group_attr == o.group_attr &&
      group_dn == o.group_dn &&
      group_filter == o.group_filter &&
      gw_bound_ips == o.gw_bound_ips &&
      json == o.json &&
      jwt_ttl == o.jwt_ttl &&
      keytab_file_data == o.keytab_file_data &&
      keytab_file_path == o.keytab_file_path &&
      krb5_conf_data == o.krb5_conf_data &&
      krb5_conf_path == o.krb5_conf_path &&
      ldap_anonymous_search == o.ldap_anonymous_search &&
      ldap_ca_cert == o.ldap_ca_cert &&
      ldap_url == o.ldap_url &&
      name == o.name &&
      product_type == o.product_type &&
      subclaims_delimiters == o.subclaims_delimiters &&
      token == o.token &&
      uid_token == o.uid_token &&
      unique_identifier == o.unique_identifier &&
      user_attribute == o.user_attribute &&
      user_dn == o.user_dn
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



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 489

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


381
382
383
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 381

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



387
388
389
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 387

def hash
  [access_expires, audit_logs_claims, bind_dn, bind_dn_password, bound_ips, delete_protection, description, force_sub_claims, group_attr, group_dn, group_filter, gw_bound_ips, json, jwt_ttl, keytab_file_data, keytab_file_path, krb5_conf_data, krb5_conf_path, ldap_anonymous_search, ldap_ca_cert, ldap_url, name, product_type, subclaims_delimiters, token, uid_token, unique_identifier, user_attribute, user_dn].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



325
326
327
328
329
330
331
332
333
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 325

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



465
466
467
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 465

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



471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 471

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



459
460
461
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 459

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



337
338
339
340
341
 
# File 'lib/akeyless/models/auth_method_create_kerberos.rb', line 337

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