Skip to main content
POST
Provision a user

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Body

application/json
role
enum<string>
default:member
Available options:
admin,
member
skipOnboarding
boolean
default:true

Response

The provision

Returned once when a user is provisioned. The API key is shown only here.

id
string

Provision record ID.

userId
string

Placeholder user ID (becomes the real user after the claim).

projectId
string

The pre-created workspace ID. The field keeps its historical name on the wire.

apiKey
string

Workspace API key (oc_…), usable immediately.

claimUrl
string

Link the user opens to claim the account.

expiresAt
string<date-time>

When the unclaimed provision expires (7 days from creation).