HttpEndpointOciResourcePrincipalAuthConfig¶

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

Bases: oci.generative_ai_agent.models.http_endpoint_auth_config.HttpEndpointAuthConfig

Specifies authentication using Oracle Cloud Infrastructure (OCI) Resource Principal, leveraging OCI’s identity-based authentication mechanism.

Attributes

`HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_CONFIG`	str(object=’’) -> str
`HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG`	str(object=’’) -> str
`http_endpoint_auth_config_type`	[Required] Gets the http_endpoint_auth_config_type of this HttpEndpointAuthConfig.

Methods

`__init__`(**kwargs)	Initializes a new HttpEndpointOciResourcePrincipalAuthConfig 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_CONFIG_TYPE_HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG = 'HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG'¶

HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_CONFIG = 'HTTP_ENDPOINT_IDCS_AUTH_CONFIG'¶

HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_CONFIG = 'HTTP_ENDPOINT_NO_AUTH_CONFIG'¶

HTTP_ENDPOINT_AUTH_CONFIG_TYPE_HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG = 'HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG'¶

__init__(**kwargs)¶

Initializes a new HttpEndpointOciResourcePrincipalAuthConfig object with values from keyword arguments. The default value of the http_endpoint_auth_config_type attribute of this class is HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_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_config_type (str) – The value to assign to the http_endpoint_auth_config_type property of this HttpEndpointOciResourcePrincipalAuthConfig. Allowed values for this property are: “HTTP_ENDPOINT_NO_AUTH_CONFIG”, “HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG”, “HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG”, “HTTP_ENDPOINT_IDCS_AUTH_CONFIG”

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_config_type¶

[Required] Gets the http_endpoint_auth_config_type of this HttpEndpointAuthConfig. The type of Auth config to be used when invoking an external endpoint. The allowed values are: - HTTP_ENDPOINT_NO_AUTH_CONFIG: Indicates that no authentication is required for invoking the endpoint. - HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG: Specifies Bearer Token Authentication, where the same Bearer token received as part of the Agent Chat API request is used to invoke the external endpoint. - HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG: Specifies authentication using Oracle Cloud Infrastructure (OCI) Resource Principal, leveraging OCI’s identity-based authentication mechanism. - HTTP_ENDPOINT_IDCS_AUTH_CONFIG: Specifies authentication using Oracle Identity Cloud Service (IDCS), leveraging OAuth 2.0 for token-based authentication.

Allowed values for this property are: “HTTP_ENDPOINT_NO_AUTH_CONFIG”, “HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG”, “HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG”, “HTTP_ENDPOINT_IDCS_AUTH_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The http_endpoint_auth_config_type of this HttpEndpointAuthConfig.
Return type:	str