createUser()
Creates a user. Your user management settings determine how you should setup your user model.
Any email address and phone number created using this method will be automatically marked as verified.
CreateUserParams
- Name
externalId?- Type
string- Description
The ID of the user you use in your external systems. Must be unique across your instance.
- Name
emailAddress[]?- Type
string- Description
Email addresses to add to the user. Must be unique across your instance. The first email address will be set as the users primary email address.
- Name
phoneNumber[]?- Type
string- Description
Phone numbers that will be added to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number.
- Name
username?- Type
string- Description
The username to give to the user. Must be unique across your instance.
- Name
password?- Type
string- Description
The plaintext password to give the user.
- Name
firstName?- Type
string- Description
The user's first name.
- Name
lastName?- Type
string- Description
The user's last name.
- Name
publicMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
- Name
privateMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the user that is only visible to your Backend API.
- Name
unsafeMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
Feedback
Last updated on