Skip to content

secrets

Accessed as client.user.actions.secrets; the async client mirrors it.

UserActionsSecrets

The user.actions.secrets namespace.

delete

delete(secretname: str) -> None

Delete a secret in a user scope.

Parameters:

Name Type Description Default
secretname str

name of the secret

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: deleteUserSecret

update

update(secretname: str, *, data: str) -> None

Create or Update a secret value in a user scope.

Parameters:

Name Type Description Default
secretname str

name of the secret

required
data str

Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: updateUserSecret

AsyncUserActionsSecrets

The user.actions.secrets namespace.

delete

delete(secretname: str) -> None

Delete a secret in a user scope.

Parameters:

Name Type Description Default
secretname str

name of the secret

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: deleteUserSecret

update

update(secretname: str, *, data: str) -> None

Create or Update a secret value in a user scope.

Parameters:

Name Type Description Default
secretname str

name of the secret

required
data str

Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: updateUserSecret