BasicAuthSecret

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

Bases: SecretDetail

The details of Basic authentication configured using a secret stored in a vault.

Attributes:

TYPE_BASIC_AUTH_SECRET

A constant which can be used with the type property of a SecretDetail.

TYPE_IDCS_SECRET

A constant which can be used with the type property of a SecretDetail.

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'

A constant which can be used with the type property of a SecretDetail. This constant has a value of “BASIC_AUTH_SECRET”

TYPE_IDCS_SECRET = 'IDCS_SECRET'

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

property type

[Required] Gets the type of this SecretDetail. The type of OpenID.

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

property 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