robocorp-vault

module robocorp.vault

Source: __init__.py:0

function get_secret

Source: __init__.py:19

get_secret(name: str, hide: bool = True) → SecretContainer

Get a secret with the given name.

Args:

  • name: Name of secret to fetch
  • hide: Hide secret values from log output

Note:

If robocorp.log is available in the environment, the hide argument controls if the given values are automatically hidden in the log output.

Returns: Secret container of name, description, and key-value pairs

Raises:

  • RobocorpVaultError: Error with API request or response payload.

function set_secret

Source: __init__.py:47

set_secret(secret: SecretContainer, hide: bool = True) → None

Set a secret value using an existing container.

Note: If the secret already exists, all contents are replaced.

Args:

  • secret: Secret container, created manually or returned by get_secret
  • hide: Hide secret values from log output

Note:

If robocorp.log is available in the environment, the hide argument controls if the given values are automatically hidden in the log output.

Raises:

  • RobocorpVaultError: Error with API request or response payload

function create_secret

Source: __init__.py:72

create_secret( name: str, values: dict[str, Any], description: str = '', exist_ok: bool = False, hide: bool = True ) → SecretContainer

Create a new secret, or overwrite an existing one.

Args:

  • name: Name of secret
  • values: Mapping of secret keys and values
  • description: Optional description for secret
  • exist_ok: Overwrite existing secret
  • hide: Hide secret values from log output

Note:

If robocorp.log is available in the environment, the hide argument controls if the given values are automatically hidden in the log output.

Returns: Secret container of name, description, and key-value pairs

Raises:

  • RobocorpVaultError: Error with API request or response payload

class SecretContainer

Source: _secrets.py:5

Container for a secret with name, description, and multiple key-value pairs.

Avoids logging internal values when possible.

Note that keys are always converted to str internally.

method __init__

Source: _secrets.py:13

__init__(name: str, description: str, values: Dict[str, Any])

Args:

  • name: Name of secret
  • description: Human-friendly description for secret
  • values: Dictionary of key-value pairs stored in secret
property description
property name

method update

Source: _secrets.py:32

update(kvpairs) → None

exception RobocorpVaultError

Source: _errors.py:1

Raised when there's problem with reading from Robocorp Vault.