Skip to main content

Documentation Index

Fetch the complete documentation index at: https://alphabet-06152314.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint creates a new Alphabet user account. On success, it returns the created user projection with a 201 Created status and a Location header pointing to the admin user detail URL. Depending on your server configuration, email confirmation may be required before the new account can sign in.

POST /api/v1/auth/register

Authorization: None required

Request body

email
string
required
The user’s email address. Must be unique across all accounts.
password
string
required
The account password. Must satisfy the configured password complexity policy (uppercase, lowercase, digit, and special character by default).
firstName
string
required
The user’s first name.
lastName
string
required
The user’s last name.

Responses

201 CreatedUserDto
userId
string
The unique identifier (GUID) for the created user.
email
string
The registered email address.
firstName
string
The user’s first name.
lastName
string
The user’s last name.
400 Bad RequestProblemDetails Returned when registration fails. Common causes include the email address already being in use or the password not meeting complexity requirements.

Example

curl -X POST https://localhost:5001/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "Password123!",
    "firstName": "Jane",
    "lastName": "Doe"
  }'

POST /api/v1/auth/confirm-email

After registration, if your deployment requires email confirmation, you will receive a userId and a time-limited token via the confirmation email. Submit both to this endpoint to verify the address and activate the account. Authorization: None required

Request body

userId
string
required
The user’s identifier, provided in the confirmation email link.
token
string
required
The email confirmation token, provided in the confirmation email link.

Responses

200 OK — Email confirmed successfully. The account is now eligible to sign in. 400 Bad RequestProblemDetails — Confirmation failed. The token may be invalid, expired, or already used.
Email confirmation tokens are single-use. If confirmation fails, request a new confirmation email through your application’s resend flow.