Invite regular user

Invite regular user to client application (requires Internal role + Create permission on users)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Email address of the user to invite. Surrounding whitespace is trimmed and the address is lowercased to become the key the invite is held under; what is left must be plain ASCII, and a quoted local part (the RFC 5321 form) is refused, since lowercasing would corrupt rather than normalize it. A blank value is read as missing.

first_name?string

First name of the user (optional). Trimmed of surrounding whitespace and invisible formatting characters; a value made only of those is read as missing.

last_name?string

Last name of the user (optional). Trimmed of surrounding whitespace and invisible formatting characters; a value made only of those is read as missing.

Response Body

`application/json`

curl -X POST "https://example.com/v1/users/invite" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

{
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "email": "user@example.com",
  "status": "pending_activation",
  "invite_sent_at": "2019-08-24T14:15:22Z",
  "invite_expires_at": "2019-08-24T14:15:22Z"
}

{
  "status": 400,
  "message": "Failed to serialize",
  "code": "common.failed_to_serialize",
  "class": "validation"
}

{
  "status": 401,
  "message": "Unauthorized",
  "code": "common.unauthorized",
  "class": "business"
}

{
  "status": 403,
  "message": "No access to the record",
  "code": "common.rbac_no_rec_access",
  "class": "business"
}

{
  "status": 409,
  "message": "Credential already exists",
  "code": "users_m.duplicate_credential",
  "class": "business"
}

{
  "status": 429,
  "message": "Rate limit for 203.0.113.10 to 456e1234-e89b-12d3-a456-426614174111 exceeded.",
  "code": "rate_limits_m.exceeded",
  "class": "temporary",
  "retryable": true
}

{
  "status": 500,
  "message": "Internal server error",
  "code": "common.server_error",
  "class": "business"
}

{
  "overall_status": "unhealthy",
  "message": "Service is shutting down",
  "timestamp": "2026-08-27T15:04:05Z"
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

409application/json

429application/json

500application/json

503application/json

Example duplicate_credential

Example user_exists

Example token_used

Example already_active

Bearer token parsed — the per-user limiter

No parseable bearer token — free text stored as the code

Graceful shutdown — not the envelope

ensureCacheAvailable failed — the envelope

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`