Sign in

v4

latestOpenAPI 3.1.02026-08-019681,1012.0 MB
users

Create Or Verify User

Create a new system user with an email and password.

If no admin exists (first user), the user will be created as an admin.

Otherwise:

  • User record was already created when the admin invited the user
  • We should verify the user's email
post/users

Query parameters

signup_tokenstring nullable

Request body

emailstring email required
first_namestring nullable
last_namestring nullable
auth_method'email' | 'google' | 'github' | 'okta' | 'azure-ad' | 'custom' | 'saml' | 'invite'
role'admin' | 'manager' | 'user' | 'read_only'
email_is_verifiedboolean nullable
passwordstring password nullable

Response

Successful Response

idstring uuid4 required
created_atstring date-time required
updated_atstring date-time required
emailstring required
first_namestring nullable
last_namestring nullable
email_is_verifiedboolean nullable
status'requested' | 'invited' | 'enabled' | 'disabled' required
role'system_admin' | 'system_user' required
auth_methodstring required