Skip to navigation
API ReferenceSecret References

Update a secret reference

Renaming (name) also updates the internal pointer. Providing vaultKey re-encrypts the secret.

Authentication

AuthorizationBearer

WorkOS API key (Authorization: Bearer sk_…). Scope comes from the key’s permissions: a key carrying passport:admin has admin scope (full catalog CRUD), any other key has member scope (reads + access requests). Organization-owned keys are admin by ownership and carry no associated user; keys minted for a user carry theirs, which is what access requests and createdBy are attributed to.

Path parameters

secretReferenceIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringOptional
vaultTypestringOptional
vaultKeystringOptional

Provide to re-encrypt with a new secret value.

metadatamap from strings to any or nullOptional
Arbitrary JSON object, or null.

Response headers

RateLimit-Limitinteger
Requests allowed in the current window.
RateLimit-Remaininginteger
Requests remaining in the current window.
RateLimit-Resetinteger
Unix epoch seconds when the window resets.

Response

OK
dataobject

The secret’s vaultKey is encrypted server-side and never returned. name is the only identifier.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error