Secrets

class EnvironmentSecret( environment_variable_name: str, )

Bases: Secret

Secrets class representing a secret obtained from an environment variable in the server.

Variables:

environment_variable_name (str) – Name of the environment variable from which we will obtain the secret value.
dict (to_dict() ->) – Convert the EnvironmentSecret object to a dictionary.
str (secret_value() ->) – Get the secret value.

property secret_value: str

Get the secret value pointed at by the secret. To be used only during execution in the backend.

class HashiCorpSecret( path: str, name: str, vault: str = 'HASHICORP', )

Bases: Secret

Secrets class representing a secret stored in Hashicorp Vault.

Variables:

path (str) – The path to the secret in Hashicorp Vault.
name (str) – The name of the secret in Hashicorp Vault.
vault (str) – If multiple vaults exist in the system, the name of the vault to use. When executing in the server, the URL and token associated to that specific vault will be used. The name can only contain uppercase letters, numbers and underscores, and can’t begin with a number. Defaults to “HASHICORP”.
dict (to_dict() ->) – Convert the HashiCorpSecret object to a dictionary.
str (secret_value() ->) – Get the secret value.

property secret_value: str

Get the secret value pointed at by the secret. To be used only during execution in the backend.