Class: Akeyless::CreateAuthMethodOIDC

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

Overview

createAuthMethodOIDC is a command that creates a new auth method that will be available to authenticate using OIDC. [Deprecated: Use auth-method-create-oidc command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAuthMethodOIDC

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 163

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

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

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

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

  if attributes.key?(:'required_scopes_prefix')
    self.required_scopes_prefix = attributes[:'required_scopes_prefix']
  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']
  else
    self.unique_identifier = nil
  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/create_auth_method_oidc.rb', line 20

def access_expires
  @access_expires
end

#allowed_client_type ⇒ Object

Returns the value of attribute allowed_client_type.



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

def allowed_client_type
  @allowed_client_type
end

#allowed_redirect_uri ⇒ Object

Allowed redirect URIs after the authentication



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

def allowed_redirect_uri
  @allowed_redirect_uri
end

#audience ⇒ Object

Audience claim to be used as part of the authentication flow. In case set, it must match the one configured on the Identity Provider’s Application



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

def audience
  @audience
end

#audit_logs_claims ⇒ Object

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



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

def audit_logs_claims
  @audit_logs_claims
end

#bound_ips ⇒ Object

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



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

def bound_ips
  @bound_ips
end

#client_id ⇒ Object

Client ID



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

def client_id
  @client_id
end

#client_secret ⇒ Object

Client Secret



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

def client_secret
  @client_secret
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Auth Method description



46
47
48
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 46

def description
  @description
end

#expiration_event_in ⇒ Object

How many days before the expiration of the auth method would you like to be notified.



49
50
51
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 49

def expiration_event_in
  @expiration_event_in
end

#force_sub_claims ⇒ Object

if true: enforce role-association must include sub claims



52
53
54
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 52

def force_sub_claims
  @force_sub_claims
end

#gw_bound_ips ⇒ Object

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



55
56
57
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 55

def gw_bound_ips
  @gw_bound_ips
end

#issuer ⇒ Object

Issuer URL



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

def issuer
  @issuer
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#jwt_ttl ⇒ Object

Jwt TTL



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

def jwt_ttl
  @jwt_ttl
end

#name ⇒ Object

Auth Method name



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

def name
  @name
end

#product_type ⇒ Object

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



70
71
72
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 70

def product_type
  @product_type
end

#required_scopes ⇒ Object

RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve



73
74
75
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 73

def required_scopes
  @required_scopes
end

#required_scopes_prefix ⇒ Object

RequiredScopesPrefix is a a prefix to add to all required-scopes when requesting them from the oidc server (for example, azures’ Application ID URI)



76
77
78
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 76

def required_scopes_prefix
  @required_scopes_prefix
end

#subclaims_delimiters ⇒ Object

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



79
80
81
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 79

def subclaims_delimiters
  @subclaims_delimiters
end

#token ⇒ Object

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



82
83
84
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 82

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



85
86
87
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 85

def uid_token
  @uid_token
end

#unique_identifier ⇒ Object

A unique identifier (ID) value should be configured for OIDC, OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a "sub claim" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.



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

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



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

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



121
122
123
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 121

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
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
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 91

def self.attribute_map
  {
    :'access_expires' => :'access-expires',
    :'allowed_client_type' => :'allowed-client-type',
    :'allowed_redirect_uri' => :'allowed-redirect-uri',
    :'audience' => :'audience',
    :'audit_logs_claims' => :'audit-logs-claims',
    :'bound_ips' => :'bound-ips',
    :'client_id' => :'client-id',
    :'client_secret' => :'client-secret',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'expiration_event_in' => :'expiration-event-in',
    :'force_sub_claims' => :'force-sub-claims',
    :'gw_bound_ips' => :'gw-bound-ips',
    :'issuer' => :'issuer',
    :'json' => :'json',
    :'jwt_ttl' => :'jwt-ttl',
    :'name' => :'name',
    :'product_type' => :'product-type',
    :'required_scopes' => :'required-scopes',
    :'required_scopes_prefix' => :'required-scopes-prefix',
    :'subclaims_delimiters' => :'subclaims-delimiters',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'unique_identifier' => :'unique-identifier'
  }
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



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

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



156
157
158
159
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 156

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

.openapi_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 126

def self.openapi_types
  {
    :'access_expires' => :'Integer',
    :'allowed_client_type' => :'Array<String>',
    :'allowed_redirect_uri' => :'Array<String>',
    :'audience' => :'String',
    :'audit_logs_claims' => :'Array<String>',
    :'bound_ips' => :'Array<String>',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'expiration_event_in' => :'Array<String>',
    :'force_sub_claims' => :'Boolean',
    :'gw_bound_ips' => :'Array<String>',
    :'issuer' => :'String',
    :'json' => :'Boolean',
    :'jwt_ttl' => :'Integer',
    :'name' => :'String',
    :'product_type' => :'Array<String>',
    :'required_scopes' => :'Array<String>',
    :'required_scopes_prefix' => :'String',
    :'subclaims_delimiters' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'unique_identifier' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_expires == o.access_expires &&
      allowed_client_type == o.allowed_client_type &&
      allowed_redirect_uri == o.allowed_redirect_uri &&
      audience == o.audience &&
      audit_logs_claims == o.audit_logs_claims &&
      bound_ips == o.bound_ips &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      expiration_event_in == o.expiration_event_in &&
      force_sub_claims == o.force_sub_claims &&
      gw_bound_ips == o.gw_bound_ips &&
      issuer == o.issuer &&
      json == o.json &&
      jwt_ttl == o.jwt_ttl &&
      name == o.name &&
      product_type == o.product_type &&
      required_scopes == o.required_scopes &&
      required_scopes_prefix == o.required_scopes_prefix &&
      subclaims_delimiters == o.subclaims_delimiters &&
      token == o.token &&
      uid_token == o.uid_token &&
      unique_identifier == o.unique_identifier
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



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

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


359
360
361
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



365
366
367
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 365

def hash
  [access_expires, allowed_client_type, allowed_redirect_uri, audience, audit_logs_claims, bound_ips, client_id, client_secret, delete_protection, description, expiration_event_in, force_sub_claims, gw_bound_ips, issuer, json, jwt_ttl, name, product_type, required_scopes, required_scopes_prefix, subclaims_delimiters, token, uid_token, unique_identifier].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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 303

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

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



443
444
445
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 443

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



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

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



437
438
439
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 437

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
323
324
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 319

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