Class: Akeyless::Configure

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Configure

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
220
221
222
223
224
225
226
227
 
# File 'lib/akeyless/models/configure.rb', line 133

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

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

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

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

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

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

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

Instance Attribute Details

#access_id ⇒ Object

Access ID



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

def access_id
  @access_id
end

#access_key ⇒ Object

Access Key



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

def access_key
  @access_key
end

#access_type ⇒ Object

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



25
26
27
 
# File 'lib/akeyless/models/configure.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/configure.rb', line 28

def 
  @account_id
end

#admin_email ⇒ Object

Email (relevant only for access-type=password)



31
32
33
 
# File 'lib/akeyless/models/configure.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/configure.rb', line 34

def admin_password
  @admin_password
end

#azure_ad_object_id ⇒ Object

Azure Active Directory ObjectId (relevant only for access-type=azure_ad)



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

def azure_ad_object_id
  @azure_ad_object_id
end

#cert_data ⇒ Object

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



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

def cert_data
  @cert_data
end

#cert_issuer_name ⇒ Object

Certificate Issuer Name



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

def cert_issuer_name
  @cert_issuer_name
end

#cert_username ⇒ Object

The username to sign in the SSH certificate (use a comma-separated list for more than one username)



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

def cert_username
  @cert_username
end

#default_location_prefix ⇒ Object

Default path prefix for name of items, targets and auth methods



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

def default_location_prefix
  @default_location_prefix
end

#gcp_audience ⇒ Object

GCP JWT audience



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

def gcp_audience
  @gcp_audience
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#k8s_auth_config_name ⇒ Object

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



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

def k8s_auth_config_name
  @k8s_auth_config_name
end

#key_data ⇒ Object

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



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

def key_data
  @key_data
end

#legacy_signing_alg_name ⇒ Object

Set this option to output legacy (‘[email protected]’) signing algorithm name in the certificate.



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

def legacy_signing_alg_name
  @legacy_signing_alg_name
end

#oci_auth_type ⇒ Object

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



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

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)



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

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



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
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/akeyless/models/configure.rb', line 308

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



97
98
99
 
# File 'lib/akeyless/models/configure.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/akeyless/models/configure.rb', line 73

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',
    :'azure_ad_object_id' => :'azure_ad_object_id',
    :'cert_data' => :'cert-data',
    :'cert_issuer_name' => :'cert-issuer-name',
    :'cert_username' => :'cert-username',
    :'default_location_prefix' => :'default-location-prefix',
    :'gcp_audience' => :'gcp-audience',
    :'json' => :'json',
    :'k8s_auth_config_name' => :'k8s-auth-config-name',
    :'key_data' => :'key-data',
    :'legacy_signing_alg_name' => :'legacy-signing-alg-name',
    :'oci_auth_type' => :'oci-auth-type',
    :'oci_group_ocid' => :'oci-group-ocid'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/akeyless/models/configure.rb', line 284

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



126
127
128
129
 
# File 'lib/akeyless/models/configure.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/akeyless/models/configure.rb', line 102

def self.openapi_types
  {
    :'access_id' => :'String',
    :'access_key' => :'String',
    :'access_type' => :'String',
    :'account_id' => :'String',
    :'admin_email' => :'String',
    :'admin_password' => :'String',
    :'azure_ad_object_id' => :'String',
    :'cert_data' => :'String',
    :'cert_issuer_name' => :'String',
    :'cert_username' => :'String',
    :'default_location_prefix' => :'String',
    :'gcp_audience' => :'String',
    :'json' => :'Boolean',
    :'k8s_auth_config_name' => :'String',
    :'key_data' => :'String',
    :'legacy_signing_alg_name' => :'Boolean',
    :'oci_auth_type' => :'String',
    :'oci_group_ocid' => :'Array<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
267
 
# File 'lib/akeyless/models/configure.rb', line 246

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 &&
      azure_ad_object_id == o.azure_ad_object_id &&
      cert_data == o.cert_data &&
      cert_issuer_name == o.cert_issuer_name &&
      cert_username == o.cert_username &&
      default_location_prefix == o.default_location_prefix &&
      gcp_audience == o.gcp_audience &&
      json == o.json &&
      k8s_auth_config_name == o.k8s_auth_config_name &&
      key_data == o.key_data &&
      legacy_signing_alg_name == o.legacy_signing_alg_name &&
      oci_auth_type == o.oci_auth_type &&
      oci_group_ocid == o.oci_group_ocid
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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/akeyless/models/configure.rb', line 379

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


271
272
273
 
# File 'lib/akeyless/models/configure.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/akeyless/models/configure.rb', line 277

def hash
  [access_id, access_key, access_type, , admin_email, admin_password, azure_ad_object_id, cert_data, cert_issuer_name, cert_username, default_location_prefix, gcp_audience, json, k8s_auth_config_name, key_data, legacy_signing_alg_name, oci_auth_type, oci_group_ocid].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



231
232
233
234
235
 
# File 'lib/akeyless/models/configure.rb', line 231

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



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

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/akeyless/models/configure.rb', line 361

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



349
350
351
 
# File 'lib/akeyless/models/configure.rb', line 349

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



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

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