IdcsSecret¶

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

Bases: oci.generative_ai_agent.models.secret_detail.SecretDetail

The details of IDCS configured as OpenID setting in OpenSearch.

Attributes

`TYPE_BASIC_AUTH_SECRET`	str(object=’’) -> str
`TYPE_IDCS_SECRET`	str(object=’’) -> str
`client_id`	[Required] Gets the client_id of this IdcsSecret.
`idcs_url`	[Required] Gets the idcs_url of this IdcsSecret.
`scope_url`	[Required] Gets the scope_url of this IdcsSecret.
`type`	[Required] Gets the type of this SecretDetail.
`vault_secret_id`	[Required] Gets the vault_secret_id of this IdcsSecret.

Methods

`__init__`(**kwargs)	Initializes a new IdcsSecret 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 IdcsSecret object with values from keyword arguments. The default value of the type attribute of this class is IDCS_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 IdcsSecret. Allowed values for this property are: “IDCS_SECRET”, “BASIC_AUTH_SECRET”
idcs_url (str) – The value to assign to the idcs_url property of this IdcsSecret.
client_id (str) – The value to assign to the client_id property of this IdcsSecret.
vault_secret_id (str) – The value to assign to the vault_secret_id property of this IdcsSecret.
scope_url (str) – The value to assign to the scope_url property of this IdcsSecret.

client_id¶

[Required] Gets the client_id of this IdcsSecret. The IDCS Connect clientId.

Returns:	The client_id of this IdcsSecret.
Return type:	str

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.

idcs_url¶

[Required] Gets the idcs_url of this IdcsSecret. The URL represent authentication url of the IDCS.

Returns:	The idcs_url of this IdcsSecret.
Return type:	str

scope_url¶

[Required] Gets the scope_url of this IdcsSecret. Fully qualified scope url

Returns:	The scope_url of this IdcsSecret.
Return type:	str

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 IdcsSecret. The OCID of the secret for client secret.

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