Skip to navigation
API ReferenceSecret References

Create a secret reference

Requires a mode-B access proxy configured for the organization (a proxy public key). Without it, encryption cannot be performed and the request returns 422.

name is the only identifier: it must be unique per namespace (a deleted reference frees its name for reuse). vaultKey is the vault lookup key/path; it is encrypted and never returned.

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

namespaceIdstringRequiredformat: "uuid"

Headers

Idempotency-KeystringOptional

Optional idempotency key, retained 24h and bound to the request that first used it. Resending the same request replays the stored response (with Idempotent-Replayed: true); reusing the key with a different body or path returns 422; retrying while the original is still in flight returns 409 with Retry-After. A failed request releases its key.

Request

This endpoint expects an object.
namestringRequired
Unique per namespace.
vaultTypestringRequired
vaultKeystringRequired

Vault lookup key/path. Encrypted server-side; never returned.

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

Created
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