Skip to main content

Register

POST 
/api/auth/register

Registers a new user account with email, password, and name. If successful, the user will receive an email with a link to verify the email address if email is enabled and configured correctly.

Requirements​

  • The email should be a valid email address (e.g., "[email protected]") that is not associated to an existing account.
  • The password must be at least 8 characters long and include at least one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*()_+={}[]|:;'"<>,.?/).

Behavior for Registering Principal with Existing Email​

If the email is already connected to an existing account, a warning will be sent to the corresponding email address informing the user if email is enabled and configured correctly.

Locale​

A locale can be specified for this request. This will be used for the email verification email. You can learn more about email verification here.

If no locale is specified, the applications default locale will be used. You can learn more about configuring the default locale here.

Request​

Responses​

Request was successful. An email was sent to the given email address. If this email exists, a notification will be send. If the email doesn't exist, an account will be created.