Secret#

class nominal.core.Secret(rid: str, name: str, description: str, properties: Mapping[str, str], labels: Sequence[str], created_at: IntegralNanosecondsUTC)#

Bases: HasRid, RefreshableGrpcMixin[Secret]

Metadata and lifecycle operations for a stored secret.

Secret values are supplied at creation and are not returned by this object.

rid: str#
name: str#
description: str#
properties: Mapping[str, str]#
labels: Sequence[str]#
created_at: IntegralNanosecondsUTC#
archive() → None#

Archive the secret, disallowing it to appear from users.

delete() → None#

Permanently delete the secret, removing it from the database entirely.

refresh() → Self#
unarchive() → None#

Unarchive the secret, allowing it to appear to users.

update(*, name: str | None = None, description: str | None = None, properties: Mapping[str, str] | None = None, labels: Sequence[str] | None = None) → Self#

Update the secret in-place.

Parameters:
  • name – New name of the secret

  • description – New description of the secret

  • properties – New properties for the secret

  • labels – New labels for the secret

Returns:

Updated secret metadata.

Note

Fields left as None are unchanged.