CreateUserRequest

A request or response body; the type column links to the schemas it refers to.

CreateUserRequest

FieldTypeRequiredDescription
display_namestring | nullno

Starting display name; the first sign-in's name claim refreshes it.

1–200 characters

emailstringyes

The address the person will sign in with; compared case-insensitively.

3–300 characters

provider_idstringyes

Sign-in provider UUID id or slug the person is expected to sign in with.

at least 1 character

jsonExample
{
  "display_name": "Ada Lovelace",
  "email": "ada@example.com",
  "provider_id": "acme-sso"
}