Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Core resources

Create a user

post/users

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

namestring

Non-empty text string

given_namestring

Non-empty text string

family_namestring

Non-empty text string

picturestring uri

HTTP(S) URL

emailstring email

An email address

zoneinfostring

IANA timezone identifier

localestring

BCP 47 locale

phone_numberstring

E.164 phone number

Example request

{
  "picture": "https://www.acme.com",
  "email": "email@domain.com",
  "zoneinfo": "America/New_York",
  "locale": "en-US",
  "phone_number": "+14155551234"
}

Response

Successful operation

namestring

Non-empty text string

given_namestring

Non-empty text string

family_namestring

Non-empty text string

picturestring uri

HTTP(S) URL

emailstring email

An email address

zoneinfostring

IANA timezone identifier

localestring

BCP 47 locale

phone_numberstring

E.164 phone number

email_verifiedboolean

A boolean value

phone_number_verifiedboolean

A boolean value

enabledboolean required

A boolean value

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "picture": "https://www.acme.com",
  "email": "email@domain.com",
  "zoneinfo": "America/New_York",
  "locale": "en-US",
  "phone_number": "+14155551234",
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}