HttpEndpointOciAuthScopeConfig

class oci.generative_ai_agent.models.HttpEndpointOciAuthScopeConfig(**kwargs)

Bases: HttpEndpointAuthScopeConfig

Specifies authentication for invoking OCI-protected services using Oracle IAM.

  • If authScope = AGENT: Uses the agent’s Resource Principal to authenticate and sign the request.

Attributes:

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_API_KEY_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig.

http_endpoint_auth_scope_config_type

[Required] Gets the http_endpoint_auth_scope_config_type of this HttpEndpointAuthScopeConfig.

Methods:

__init__(**kwargs)

Initializes a new HttpEndpointOciAuthScopeConfig 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'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “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'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG”

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “HTTP_ENDPOINT_BEARER_AUTH_SCOPE_CONFIG”

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “HTTP_ENDPOINT_IDCS_AUTH_SCOPE_CONFIG”

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “HTTP_ENDPOINT_NO_AUTH_SCOPE_CONFIG”

HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG = 'HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG'

A constant which can be used with the http_endpoint_auth_scope_config_type property of a HttpEndpointAuthScopeConfig. This constant has a value of “HTTP_ENDPOINT_OCI_AUTH_SCOPE_CONFIG”

__init__(**kwargs)

Initializes a new HttpEndpointOciAuthScopeConfig object with values from keyword arguments. The default value of the http_endpoint_auth_scope_config_type attribute of this class is HTTP_ENDPOINT_OCI_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 HttpEndpointOciAuthScopeConfig. 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”

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.

property 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