HttpEndpointAuthScopeConfig

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

Bases: object

Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.

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 HttpEndpointAuthScopeConfig 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 HttpEndpointAuthScopeConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• HttpEndpointBearerAuthScopeConfig
• HttpEndpointNoAuthScopeConfig
• HttpEndpointBasicAuthScopeConfig
• HttpEndpointOciAuthScopeConfig
• HttpEndpointIdcsAuthScopeConfig
• HttpEndpointApiKeyAuthScopeConfig

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 HttpEndpointAuthScopeConfig. 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’.

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