AuthResponse

The response body for the login operation.

Important

Note that the actual session token is returned in the wtsession cookie in the response headers (Set-Cookie). It is also available in the header X-Session-Id. The token is not returned in the response body.

auth object

Properties about the authentication request.

abilitiesstring[]

An array of abilities that the user has.

Example: ["userdel","accruals_del","admin"]

expiresnumber

The expiration time of the token as a Unix timestamp. Note that using the token again at any time before the expiration occurs will automatically extend the expiration time.

Example: 1728605420.527636

expiresSecondsinteger

The number of seconds until the token expires.

Example: 102000

userIdstring

The unique identifier of the user.

Example: 1A40D7570AF94AFDB286D0697DEA5CF3

usernamestring

The username (also known as the login ID).

Example: john_doe@example.com

successboolean

Indicates whether the request was successful.

Example: true

AuthResponse

{
  "auth": {
    "abilities": [
      "userdel",
      "accruals_del",
      "admin"
    ],
    "expires": 1728605420.527636,
    "expiresSeconds": 102000,
    "userId": "1A40D7570AF94AFDB286D0697DEA5CF3",
    "username": "john_doe@example.com"
  },
  "success": true
}