HttpEndpointIdcsAuthScopeConfig¶

class oci.generative_ai_agent.models.HttpEndpointIdcsAuthScopeConfig(**kwargs)¶

Bases: oci.generative_ai_agent.models.http_endpoint_auth_scope_config.HttpEndpointAuthScopeConfig

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

Only supported with authScope = AGENT.

Attributes

`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG`	str(object=’’) -> str
`client_id`	[Required] Gets the client_id of this HttpEndpointIdcsAuthScopeConfig.
`http_endpoint_auth_scope_config_type`	[Required] Gets the http_endpoint_auth_scope_config_type of this HttpEndpointAuthScopeConfig.
`idcs_url`	[Required] Gets the idcs_url of this HttpEndpointIdcsAuthScopeConfig.
`scope_url`	[Required] Gets the scope_url of this HttpEndpointIdcsAuthScopeConfig.
`vault_secret_id`	[Required] Gets the vault_secret_id of this HttpEndpointIdcsAuthScopeConfig.

Methods

`__init__`(**kwargs)	Initializes a new HttpEndpointIdcsAuthScopeConfig object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG'¶

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG'¶

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG'¶

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG'¶

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG'¶

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG'¶

__init__(**kwargs)¶

Initializes a new HttpEndpointIdcsAuthScopeConfig object with values from keyword arguments. The default value of the http_endpoint_auth_scope_config_type attribute of this class is HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

http_endpoint_auth_scope_config_type (str) – The value to assign to the http_endpoint_auth_scope_config_type property of this HttpEndpointIdcsAuthScopeConfig. Allowed values for this property are: “HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG”
idcs_url (str) – The value to assign to the idcs_url property of this HttpEndpointIdcsAuthScopeConfig.
scope_url (str) – The value to assign to the scope_url property of this HttpEndpointIdcsAuthScopeConfig.
client_id (str) – The value to assign to the client_id property of this HttpEndpointIdcsAuthScopeConfig.
vault_secret_id (str) – The value to assign to the vault_secret_id property of this HttpEndpointIdcsAuthScopeConfig.

client_id¶

[Required] Gets the client_id of this HttpEndpointIdcsAuthScopeConfig. IDCS client ID.

Returns:	The client_id of this HttpEndpointIdcsAuthScopeConfig.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

http_endpoint_auth_scope_config_type¶

[Required] Gets the http_endpoint_auth_scope_config_type of this HttpEndpointAuthScopeConfig. The type of authentication to be applied for this HTTP Endpoint.

Allowed values for this property are: “HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG”, “HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The http_endpoint_auth_scope_config_type of this HttpEndpointAuthScopeConfig.
Return type:	str

idcs_url¶

[Required] Gets the idcs_url of this HttpEndpointIdcsAuthScopeConfig. IDCS OpenID discovery endpoint.

Returns:	The idcs_url of this HttpEndpointIdcsAuthScopeConfig.
Return type:	str

scope_url¶

[Required] Gets the scope_url of this HttpEndpointIdcsAuthScopeConfig. OAuth2 scopes for token generation.

Returns:	The scope_url of this HttpEndpointIdcsAuthScopeConfig.
Return type:	str

vault_secret_id¶

[Required] Gets the vault_secret_id of this HttpEndpointIdcsAuthScopeConfig. Vault secret OCID containing the client secret.

Returns:	The vault_secret_id of this HttpEndpointIdcsAuthScopeConfig.
Return type:	str