Sign in
Auth

Exchange username + password for a bearer JWT

Changed on
post/api/v1/auth/login

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/auth/login
  • Auth: none declared

Request body

passwordstring password required

Account password.

usernamestring required

Account username to authenticate.

Example request

{
  "password": "S3cure-pass",
  "username": "li.wei"
}

Response

Login succeeded; returns JWT and current user.

expiresAtstring date-time

Time the token expires.

jwtstring required

Signed JWT bearer token for subsequent requests.

Example response

{
  "expiresAt": "2026-06-28T09:25:00Z",
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJsaS53ZWkifQ.sig",
  "tenantRoles": [
    {
      "roleName": "admin",
      "tenantName": "team-vision"
    },
    {
      "roleName": "member",
      "tenantName": "team-nlp"
    }
  ],
  "user": {
    "createdAt": "2026-06-20T08:00:00Z",
    "disabled": false,
    "displayName": "Li Wei",
    "email": "li.wei@axisml.io",
    "id": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
    "mustChangePassword": false,
    "updatedAt": "2026-06-28T09:30:00Z",
    "username": "li.wei"
  }
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the system-admin enum value from the // response property for the response status

    • info

      removed the tenant-admin enum value from the // response property for the response status

    • info

      removed the user enum value from the // response property for the response status