Documentation

Secrets

SecretsResource

Methods

create() ->
CloudSecret
post/v5/sgp/secrets

Create an account-level secret.

The secret value is stored in the cloud provider's secret store. SGP only stores metadata (key name, description, audit info). The value is never returned by any API. Returns 409 if a secret with the same key already exists.

list() -> SyncCursorPage[
CloudSecret
]
get/v5/sgp/secrets

List secret metadata for the account. Values are never returned.

retrieve() ->
CloudSecret
get/v5/sgp/secrets/{secret_id}

Get a single secret's metadata by ID. The value is never returned.

update(, ) ->
CloudSecret
patch/v5/sgp/secrets/{secret_id}

Update an existing secret's description and/or value.

If value is provided, the cloud provider secret is updated. The secret value is never returned by any API.

delete()
delete/v5/sgp/secrets/{secret_id}

Delete a secret from both the cloud provider and SGP metadata.

Domain types

class CloudSecret: ...

API response model for a secret. Never includes the secret value.