v1

latestOpenAPI 3.1.0MIT2026-07-173438118.7 KB

Auth

User registration

Errors

Returns an error if input validation fails, user already exists, or database operations fail.

post/api/auth/register

Request body

displayNamestring nullable

Optional display name for the user

emailstring required

Email address for new user registration

passwordstring required

User's password (minimum 8 characters)

Example request

{
  "email": "user@example.com",
  "password": "password123"
}

Response

Registration successful

messagestring required

Registration confirmation message

Example response

{
  "message": "Registration successful. Please check your email for verification.",
  "user": {
    "authProvider": "email",
    "displayName": "John Doe",
    "email": "user@example.com",
    "emailVerified": false,
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  }
}