Class: OCI::GenerativeAiAgent::Models::HttpEndpointIdcsAuthScopeConfig

Inherits:
HttpEndpointAuthScopeConfig show all
Defined in:
lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb

Overview

Specifies authentication using Oracle Identity Cloud Service (IDCS), leveraging OAuth 2.0 Client Credentials grant type.

  • Only supported with authScope = AGENT.

Constant Summary

Constants inherited from HttpEndpointAuthScopeConfig

OCI::GenerativeAiAgent::Models::HttpEndpointAuthScopeConfig::HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from HttpEndpointAuthScopeConfig

#http_endpoint_auth_scope_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HttpEndpointAuthScopeConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HttpEndpointIdcsAuthScopeConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :idcs_url (String) —

    The value to assign to the #idcs_url property

  • :scope_url (String) —

    The value to assign to the #scope_url property

  • :client_id (String) —

    The value to assign to the #client_id property

  • :vault_secret_id (String) —

    The value to assign to the #vault_secret_id property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 67

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['httpEndpointAuthScopeConfigType'] = 'HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.idcs_url = attributes[:'idcsUrl'] if attributes[:'idcsUrl']

  raise 'You cannot provide both :idcsUrl and :idcs_url' if attributes.key?(:'idcsUrl') && attributes.key?(:'idcs_url')

  self.idcs_url = attributes[:'idcs_url'] if attributes[:'idcs_url']

  self.scope_url = attributes[:'scopeUrl'] if attributes[:'scopeUrl']

  raise 'You cannot provide both :scopeUrl and :scope_url' if attributes.key?(:'scopeUrl') && attributes.key?(:'scope_url')

  self.scope_url = attributes[:'scope_url'] if attributes[:'scope_url']

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

  raise 'You cannot provide both :clientId and :client_id' if attributes.key?(:'clientId') && attributes.key?(:'client_id')

  self.client_id = attributes[:'client_id'] if attributes[:'client_id']

  self.vault_secret_id = attributes[:'vaultSecretId'] if attributes[:'vaultSecretId']

  raise 'You cannot provide both :vaultSecretId and :vault_secret_id' if attributes.key?(:'vaultSecretId') && attributes.key?(:'vault_secret_id')

  self.vault_secret_id = attributes[:'vault_secret_id'] if attributes[:'vault_secret_id']
end

Instance Attribute Details

#client_id ⇒ String

[Required] IDCS client ID.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 25

def client_id
  @client_id
end

#idcs_url ⇒ String

[Required] IDCS OpenID discovery endpoint.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 17

def idcs_url
  @idcs_url
end

#scope_url ⇒ String

[Required] OAuth2 scopes for token generation.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 21

def scope_url
  @scope_url
end

#vault_secret_id ⇒ String

[Required] Vault secret OCID containing the client secret.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 29

def vault_secret_id
  @vault_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'http_endpoint_auth_scope_config_type': :'httpEndpointAuthScopeConfigType',
    'idcs_url': :'idcsUrl',
    'scope_url': :'scopeUrl',
    'client_id': :'clientId',
    'vault_secret_id': :'vaultSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'http_endpoint_auth_scope_config_type': :'String',
    'idcs_url': :'String',
    'scope_url': :'String',
    'client_id': :'String',
    'vault_secret_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 109

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    http_endpoint_auth_scope_config_type == other.http_endpoint_auth_scope_config_type &&
    idcs_url == other.idcs_url &&
    scope_url == other.scope_url &&
    client_id == other.client_id &&
    vault_secret_id == other.vault_secret_id
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



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/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 143

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


123
124
125
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 132

def hash
  [http_endpoint_auth_scope_config_type, idcs_url, scope_url, client_id, vault_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 176

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



170
171
172
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_idcs_auth_scope_config.rb', line 170

def to_s
  to_hash.to_s
end