BasicAuthSecret

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

Bases: oci.generative_ai_agent.models.secret_detail.SecretDetail

The details of Basic authentication configured as in OpenSearch.

Attributes

TYPE_BASIC_AUTH_SECRET str(object=’’) -> str
TYPE_IDCS_SECRET str(object=’’) -> str
type [Required] Gets the type of this SecretDetail.
vault_secret_id [Required] Gets the vault_secret_id of this BasicAuthSecret.

Methods

__init__(**kwargs) Initializes a new BasicAuthSecret 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.
TYPE_BASIC_AUTH_SECRET = 'BASIC_AUTH_SECRET'
TYPE_IDCS_SECRET = 'IDCS_SECRET'
__init__(**kwargs)

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

Parameters:
  • type (str) – The value to assign to the type property of this BasicAuthSecret. Allowed values for this property are: “IDCS_SECRET”, “BASIC_AUTH_SECRET”
  • vault_secret_id (str) – The value to assign to the vault_secret_id property of this BasicAuthSecret.
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.

type

[Required] Gets the type of this SecretDetail. The type of OpenID. The allowed values are: - IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS. - BASIC_AUTH_SECRET: Basic authentication use for OpenSearch

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

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

[Required] Gets the vault_secret_id of this BasicAuthSecret. The OCID of the secret for basic authentication.

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