Skip to main content
POST
Add Vault Item Field

Authorizations

X-Api-Key
string
header
required

Path Parameters

itemId
string<uuid>
required

Body

application/json
field
object
required

Write shape for a field. The server derives key from label.

value
string
required
Required string length: 1 - 8192

Response

The request has succeeded.

A vault item. Secret values live in WorkOS and never appear here.

createdAt
string<date-time>
required
fields
object[]
required
id
string<uuid>
required
itemKey
string
required

Derived from name: kebab-case. Unique per organisation. Changes when the item is renamed.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
kind
enum<string>
required

Kind of vault item. Templates and items need at least one field. Completeness is per-field required.

Available options:
login,
api_key,
card,
custom
name
string
required
Required string length: 1 - 200
organizationId
string<uuid>
required
updatedAt
string<date-time>
required
createdBy
string<uuid>
lastRotatedAt
string<date-time>
lastRotatedBy
string<uuid>
lastUsedAt
string<date-time>
sourceAgentProfileId
string<uuid>

Set when this item was mirrored from a legacy agent-profile credentials set. Provenance only; the item is editable in the vault UI.

templateId
string<uuid>

Template snapshotted at create. Provenance only.