# 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*](https://docs.python.org/3/library/typing.html#typing.Self "(in Python v3.15)")

### 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*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") *|* *None*)

      New name of the secret
    - **description** ([*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") *|* *None*)

      New description of the secret
    - **properties** ([*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.15)")*[*[*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*,* [*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*]* *|* *None*)

      New properties for the secret
    - **labels** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.15)")*[*[*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*]* *|* *None*)

      New labels for the secret

Returns:
:   Updated secret metadata.

Return type:
:   [*Self*](https://docs.python.org/3/library/typing.html#typing.Self "(in Python v3.15)")

> **Note**
>
> Fields left as None are unchanged.