Skip to main content
POST
Create user account

Authorizations

Authorization
string
header
required

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

Body

application/json

Represents a user account with profile information and tutorial status

userName
string<email>

The user's username — an email address used for authentication. Matches the path-parameter form on /users/{userName}. (Previously $ref'd IdentifierPattern, which disallowed '@' and '.'; that was never enforced at runtime so production data is all emails.)

password
string
write-only

User's password (only included in create/update requests, never in responses)

email
string<email>

User's email address, used for authentication and notifications

firstName
string

User's first name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64
lastName
string

User's last name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64
businessRole
string

User's business role or job title

tutorialStatus
object

Represents the tutorial completion status and user preferences for onboarding

Response

User created successfully

Represents a user account with profile information and tutorial status

userName
string<email>

The user's username — an email address used for authentication. Matches the path-parameter form on /users/{userName}. (Previously $ref'd IdentifierPattern, which disallowed '@' and '.'; that was never enforced at runtime so production data is all emails.)

email
string<email>

User's email address, used for authentication and notifications

firstName
string

User's first name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64
lastName
string

User's last name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64
businessRole
string

User's business role or job title

tutorialStatus
object

Represents the tutorial completion status and user preferences for onboarding