Class: Akeyless::CreateMcpSecretOAuthAuthCode

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMcpSecretOAuthAuthCode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accessibility ⇒ Object

for personal password manager



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

def accessibility
  @accessibility
end

#ara_enabled ⇒ Object

Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag.



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

def ara_enabled
  @ara_enabled
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#enable_agentic_runtime_authority ⇒ Object

EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working.



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

def enable_agentic_runtime_authority
  @enable_agentic_runtime_authority
end

#enable_ai_quorum ⇒ Object

Turns on AI Quorum checks for this item.



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

def enable_ai_quorum
  @enable_ai_quorum
end

#input_rule ⇒ Object

Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)



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

def input_rule
  @input_rule
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#max_versions ⇒ Object

Set the maximum number of versions, limited by the account settings defaults.



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

def max_versions
  @max_versions
end

#metadata ⇒ Object

Deprecated - use description



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

def metadata
  @metadata
end

#name ⇒ Object

Secret name



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

def name
  @name
end

#oauth_client_id ⇒ Object

OAuth client ID



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

def oauth_client_id
  @oauth_client_id
end

#oauth_client_secret ⇒ Object

OAuth client secret



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

def oauth_client_secret
  @oauth_client_secret
end

#oauth_redirect_uri ⇒ Object

OAuth redirect URI



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

def oauth_redirect_uri
  @oauth_redirect_uri
end

#oauth_refresh_token ⇒ Object

OAuth refresh token



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

def oauth_refresh_token
  @oauth_refresh_token
end

#oauth_scopes ⇒ Object

OAuth scopes



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

def oauth_scopes
  @oauth_scopes
end

#oauth_token_url ⇒ Object

OAuth token URL



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

def oauth_token_url
  @oauth_token_url
end

#output_rule ⇒ Object

Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)



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

def output_rule
  @output_rule
end

#protection_key ⇒ Object

Returns the value of attribute protection_key.



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

def protection_key
  @protection_key
end

#tags ⇒ Object

Add tags attached to this object



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

def tags
  @tags
end

#token ⇒ Object

Authentication token (see /auth and /configure)



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#url ⇒ Object

URL of the service



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

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 366

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



116
117
118
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 87

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'ara_enabled' => :'ara-enabled',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'enable_agentic_runtime_authority' => :'enable-agentic-runtime-authority',
    :'enable_ai_quorum' => :'enable-ai-quorum',
    :'input_rule' => :'input-rule',
    :'json' => :'json',
    :'max_versions' => :'max-versions',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'oauth_client_id' => :'oauth-client-id',
    :'oauth_client_secret' => :'oauth-client-secret',
    :'oauth_redirect_uri' => :'oauth-redirect-uri',
    :'oauth_refresh_token' => :'oauth-refresh-token',
    :'oauth_scopes' => :'oauth-scopes',
    :'oauth_token_url' => :'oauth-token-url',
    :'output_rule' => :'output-rule',
    :'protection_key' => :'protection_key',
    :'tags' => :'tags',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'url' => :'url'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 342

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



150
151
152
153
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 150

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

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 121

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'ara_enabled' => :'Boolean',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'enable_agentic_runtime_authority' => :'Boolean',
    :'enable_ai_quorum' => :'Boolean',
    :'input_rule' => :'Array<String>',
    :'json' => :'Boolean',
    :'max_versions' => :'String',
    :'metadata' => :'String',
    :'name' => :'String',
    :'oauth_client_id' => :'String',
    :'oauth_client_secret' => :'String',
    :'oauth_redirect_uri' => :'String',
    :'oauth_refresh_token' => :'String',
    :'oauth_scopes' => :'Array<String>',
    :'oauth_token_url' => :'String',
    :'output_rule' => :'Array<String>',
    :'protection_key' => :'String',
    :'tags' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 299

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      ara_enabled == o.ara_enabled &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      enable_agentic_runtime_authority == o.enable_agentic_runtime_authority &&
      enable_ai_quorum == o.enable_ai_quorum &&
      input_rule == o.input_rule &&
      json == o.json &&
      max_versions == o.max_versions &&
      metadata == o.metadata &&
      name == o.name &&
      oauth_client_id == o.oauth_client_id &&
      oauth_client_secret == o.oauth_client_secret &&
      oauth_redirect_uri == o.oauth_redirect_uri &&
      oauth_refresh_token == o.oauth_refresh_token &&
      oauth_scopes == o.oauth_scopes &&
      oauth_token_url == o.oauth_token_url &&
      output_rule == o.output_rule &&
      protection_key == o.protection_key &&
      tags == o.tags &&
      token == o.token &&
      uid_token == o.uid_token &&
      url == o.url
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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 437

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


329
330
331
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 335

def hash
  [accessibility, ara_enabled, delete_protection, description, enable_agentic_runtime_authority, enable_ai_quorum, input_rule, json, max_versions, metadata, name, oauth_client_id, oauth_client_secret, oauth_redirect_uri, oauth_refresh_token, oauth_scopes, oauth_token_url, output_rule, protection_key, tags, token, uid_token, url].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



279
280
281
282
283
284
285
286
287
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 279

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



413
414
415
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 419

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



407
408
409
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 407

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



291
292
293
294
295
 
# File 'lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb', line 291

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