Register

​

POST /api/auth/register

​

Request Body

​

Headers

​

Response

​

Rate Limiting

​

Registration Modes

1. Open registration: Users can register without an invite code
2. Invite-only: Users must provide a valid invite code
3. Registration disabled: No new registrations allowed

​

Invite Code Validation

• Code is matched against invite ID or code string
• Checks expiration date (if set)
• Checks maximum uses (if set)
• Increments usage counter on successful registration

​

Error Responses

• 400 Bad Request - Invites aren’t enabled (when code is provided but invites are disabled)
• 400 Bad Request - User registration is disabled (when no code and registration disabled)
• 400 Bad Request - Username is taken
• 400 Bad Request - Invalid invite code (expired, max uses reached, or doesn’t exist)
• 429 Too Many Requests - Rate limit exceeded

​

Example Request (Open Registration)

curl -X POST https://your-zipline-instance.com/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "newuser",
    "password": "securepassword123"
  }'

​

Example Request (With Invite Code)

curl -X POST https://your-zipline-instance.com/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "newuser",
    "password": "securepassword123",
    "code": "invite-abc-123"
  }'

​

Example Response

{
  "user": {
    "id": "clx9876543210",
    "username": "newuser",
    "role": "USER",
    "createdAt": "2024-03-03T12:00:00.000Z",
    "updatedAt": "2024-03-03T12:00:00.000Z",
    "view": {},
    "oauthProviders": [],
    "totpSecret": null,
    "quota": null,
    "avatar": null,
    "token": "zpl_xyz789abc123def456"
  }
}

​

Notes

• Successfully registers the user and creates a session automatically
• Generates a unique API token for the new user
• Password is hashed using secure hashing before storage
• New users are assigned the USER role by default