Register - SnackBase

POST

api

auth

curl --request POST \
  --url https://api.example.com/api/v1/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "<string>",
  "account_name": "<string>",
  "account_slug": "<string>"
}
'

{
  "message": "<string>",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "role": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "account": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Body

application/json

Request body for account registration.

string<email>

required

User's email address

password

string

required

User's password

Minimum string length: 1

account_name

string | null

Display name for the account (required in multi-tenant mode)

Required string length: 1 - 255

account_slug

string | null

URL-friendly account identifier (auto-generated if not provided)

Required string length: 3 - 32

Response

Successful Response

Response for successful registration (verification required).

message

string

required

Success message instructing to verify email

user

UserResponse · object

required

User information

Show child attributes

account

AccountResponse · object

required

Account information

Show child attributes

LoginAuthenticate a user and return JWT tokens. Validates the user's credentials against the specified account and returns JWT tokens for authenticated access. Flow: 1. Resolve account by slug or ID 2. Look up user by email in account 3. Check authentication provider (OAuth/SAML users must use their respective flows) 4. Verify password using timing-safe comparison 5. Check if user is active 6. Update last_login timestamp 7. Generate JWT tokens 8. Return response Security: - All authentication failures return the same generic 401 message - Password verification is always performed (even with dummy hash) to prevent timing attacks

curl --request POST \
  --url https://api.example.com/api/v1/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "<string>",
  "account_name": "<string>",
  "account_slug": "<string>"
}
'

{
  "message": "<string>",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "role": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "account": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}