Authentication

Authenticate a user account.

/auth

Authenticate a user account.

Request parameters

{
  "username": "email@example.com",
  "password": "example",
  "recaptchaResponse": "example",
  "mfa_token": "example"
}

Responses

{
  "id": 96,
  "username": "email@example.com",
  "data": {
    "firstname": "Geoff",
    "lastname": "Rey"
  },
  "status": "ACTIVE",
  "dateCreated": 1736505915,
  "dateModified": 1736505915,
  "isRegistered": true,
  "lastLogin": 1736505915,
  "mfaEnabled": [
    "google"
  ],
  "parentId": 96,
  "permissions": [
    96
  ],
  "zone": 96,
  "zones": [
    {
      "id": 1,
      "name": "Default"
    }
  ]
}

User registration

/register

Responses

Request a password reset email

/password-reset-request

Responses

Reset password with token

/password-reset

Responses

Request MFA reset

/mfa-reset-request

Responses

Get MFA setup details

/mfa-setup

Responses

Configure MFA

/mfa-setup

Responses

Unlock account with token

/account-unlock

Responses

Emulate another user (Admin only)

/emulate

Responses

Retrieve the current authenticated user account.

/emulate

Retrieve the current authenticated user account.

Request parameters

Responses

{
  "id": 96,
  "username": "email@example.com",
  "data": {
    "firstname": "Geoff",
    "lastname": "Rey"
  },
  "status": "ACTIVE",
  "dateCreated": 1736505915,
  "dateModified": 1736505915,
  "isRegistered": true,
  "lastLogin": 1736505915,
  "mfaEnabled": [
    "google"
  ],
  "parentId": 96,
  "permissions": [
    96
  ],
  "zone": 96,
  "zones": [
    {
      "id": 1,
      "name": "Default"
    }
  ]
}

Authenticate using a token

/token-auth

Responses

Get MFA setup instructions

/mfa-setup-get

Responses

01 September 2026