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.

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



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

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_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?(:'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?(:'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']
  end

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

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

Allowed redirect URIs after the authentication



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

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



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

def audience
  @audience
end

#bound_ips ⇒ Object

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



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

def bound_ips
  @bound_ips
end

#client_id ⇒ Object

Client ID



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

def client_id
  @client_id
end

#client_secret ⇒ Object

Client Secret



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

def client_secret
  @client_secret
end

#force_sub_claims ⇒ Object

if true: enforce role-association must include sub claims



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

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



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

def gw_bound_ips
  @gw_bound_ips
end

#issuer ⇒ Object

Issuer URL



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

def issuer
  @issuer
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#jwt_ttl ⇒ Object

Jwt TTL



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

def jwt_ttl
  @jwt_ttl
end

#name ⇒ Object

Auth Method name



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

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



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

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)



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

def required_scopes_prefix
  @required_scopes_prefix
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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.



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

def unique_identifier
  @unique_identifier
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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/create_auth_method_oidc.rb', line 71

def self.attribute_map
  {
    :'access_expires' => :'access-expires',
    :'allowed_redirect_uri' => :'allowed-redirect-uri',
    :'audience' => :'audience',
    :'bound_ips' => :'bound-ips',
    :'client_id' => :'client-id',
    :'client_secret' => :'client-secret',
    :'force_sub_claims' => :'force-sub-claims',
    :'gw_bound_ips' => :'gw-bound-ips',
    :'issuer' => :'issuer',
    :'json' => :'json',
    :'jwt_ttl' => :'jwt-ttl',
    :'name' => :'name',
    :'required_scopes' => :'required-scopes',
    :'required_scopes_prefix' => :'required-scopes-prefix',
    :'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



283
284
285
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 283

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

def self.openapi_types
  {
    :'access_expires' => :'Integer',
    :'allowed_redirect_uri' => :'Array<String>',
    :'audience' => :'String',
    :'bound_ips' => :'Array<String>',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'force_sub_claims' => :'Boolean',
    :'gw_bound_ips' => :'Array<String>',
    :'issuer' => :'String',
    :'json' => :'Boolean',
    :'jwt_ttl' => :'Integer',
    :'name' => :'String',
    :'required_scopes' => :'Array<String>',
    :'required_scopes_prefix' => :'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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_expires == o.access_expires &&
      allowed_redirect_uri == o.allowed_redirect_uri &&
      audience == o.audience &&
      bound_ips == o.bound_ips &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      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 &&
      required_scopes == o.required_scopes &&
      required_scopes_prefix == o.required_scopes_prefix &&
      token == o.token &&
      uid_token == o.uid_token &&
      unique_identifier == o.unique_identifier
end

#_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



314
315
316
317
318
319
320
321
322
323
324
325
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
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 314

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 385

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

#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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 290

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 276

def hash
  [access_expires, allowed_redirect_uri, audience, bound_ips, client_id, client_secret, force_sub_claims, gw_bound_ips, issuer, json, jwt_ttl, name, required_scopes, required_scopes_prefix, 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



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 223

def list_invalid_properties
  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



361
362
363
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 361

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



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

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



355
356
357
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 355

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



238
239
240
241
242
 
# File 'lib/akeyless/models/create_auth_method_oidc.rb', line 238

def valid?
  return false if @name.nil?
  return false if @unique_identifier.nil?
  true
end