Secrets hooks

Hand-written shim. Implementation is generated; see ./secrets.gen.

Hooks

useCreateSecret mutation

Create a secret. The value is encrypted at rest and never returned.

useCreateSecret(options?: MutationOpts<Secret, CreateSecretParams>)

Types: Secret · CreateSecretParams

useDeleteSecret mutation

Soft-delete a secret.

useDeleteSecret(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListSecrets query

List secrets with pagination. Values are never returned.

useListSecrets(params?: Omit<ListSecretsParams, | > & { filter?: SecretFilter; orderBy?: SecretOrderBy[]; } & SecretShorthands, options?: QueryOpts<Page<Secret>>)

Types: ListSecretsParams · SecretFilter · SecretOrderBy · SecretShorthands · Page · Secret

usePurgeSecret composite

Permanently delete a soft-deleted secret (erasure — removes the ciphertext).

usePurgeSecret(options?: MutationOpts<SuccessResponse, PurgeSecretParams>)

Types: SuccessResponse · PurgeSecretParams

useRestoreSecret composite

Restore a soft-deleted secret.

useRestoreSecret(options?: MutationOpts<Secret, string>)

Types: Secret

useRetrieveSecret query

Get a single secret by ID (metadata only — never the value).

useRetrieveSecret(id: string, options?: QueryOpts<Secret>)

Types: Secret

useUpdateSecret mutation

Update a secret's name, value, or metadata.

useUpdateSecret(options?: MutationOpts<Secret, UpdateSecretParams>)

Types: Secret · UpdateSecretParams