Skip to main content
POST
inviteUser

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
email
string
required

An email address

roleIds
string[]
required

Role IDs to assign to the user upon invite. At least one role is required.

UUID v4 with automatic base62 encoding for client-facing APIs

Response

Successful response

data
object
required

The base info about a user. id stays Identity.UserID (not Auditable's Identity.UUID) so the wire/auth contract keeps the actor scalar.

meta
object
required