Secret#

class nominal.core.Secret(rid, name, description, properties, labels, created_at)#

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()#

Archive the secret, disallowing it to appear from users.

delete()#

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

refresh()#
Return type:

Self

unarchive()#

Unarchive the secret, allowing it to appear to users.

update(*, name=None, description=None, properties=None, labels=None)#

Update the secret in-place.

Parameters:

  • name (str | None)

    New name of the secret

  • description (str | None)

    New description of the secret

  • properties (Mapping[str, str] | None)

    New properties for the secret

  • labels (Sequence[str] | None)

    New labels for the secret

Returns:

Updated secret metadata.

Return type:

Self

Note

Fields left as None are unchanged.