Users

Create user

POST
Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link.

Query parameters

team_idstringOptional

Request

This endpoint expects an object.
oauth_providers
list of objectsOptional
display_name
stringOptional
Human-readable user display name, used in places like frontend UI. This is not a unique identifier.
profile_image_url
stringOptional
Profile image URL
client_metadata
map from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
server_metadata
map from strings to anyOptional
Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.
primary_email
stringOptional
Primary email
primary_email_verified
booleanOptional
Whether the primary email has been verified to belong to this user
primary_email_auth_enabled
booleanOptional
Whether the primary email can be used to sign into this user's account
password
stringOptional
A new password for the user, overwriting the old one (if it exists).
selected_team_id
stringOptional
ID of the team currently selected by the user

Response

This endpoint returns an object
project_id
string
The immutable ID used to uniquely identify this project
id
string
The immutable ID used to uniquely identify this user
primary_email_verified
boolean
Whether the primary email has been verified to belong to this user
signed_up_at_millis
double
Signed up at milliseconds
has_password
boolean
Whether the user has a password associated with their account
auth_with_email
boolean
Whether the user can authenticate with their primary e-mail. If set to true, the user can log-in with credentials and/or magic link, if enabled in the project settings.
oauth_providers
list of objects
A list of OAuth providers connected to this account
primary_email
stringOptional
Primary email
display_name
stringOptional
Human-readable user display name, used in places like frontend UI. This is not a unique identifier.
selected_team
objectOptional
selected_team_id
stringOptional
ID of the team currently selected by the user
profile_image_url
stringOptional
Profile image URL
client_metadata
map from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
server_metadata
map from strings to anyOptional
Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.