Authentication

Authentication endpoints create and maintain the bearer token used by the rest of the API.

POST

Create a session

/loginlinxio.auth.login(request)

Authenticates a Linxio user and returns a JWT token plus refresh token.

Request headers

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Email address for the Linxio user.

string

required

Password for the Linxio user.

string

optional

Optional tenant-domain hint accepted by some login flows.

Response body fields

string

optional

JWT bearer token for authenticated requests.

string

optional

Refresh token for renewing the session.

ISODateString

optional

Token expiry timestamp when supplied by Linxio.

boolean

optional

Whether OTP must be completed before the session is usable.

string

optional

Team type such as client, reseller, or admin when supplied.

LinxioId

optional

Role identifier when supplied.

Request

curl -X POST https://api.linxio.com/api/login \
  -H "Content-Type: application/json" \
  --data '{
    "email": "user@example.com",
    "password": "your-password"
  }'

Example response


{
  "token": "jwt_token",
  "refreshToken": "refresh_token",
  "expireAt": "2026-06-08T12:00:00+08:00",
  "otp_required": true,
  "teamType": "string",
  "roleId": 64553
}

POST /login/otp

POST

Verify one-time password

/login/otplinxio.auth.verifyOtp(request)

Completes OTP verification when Linxio requires it for the account.

Request headers

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Email address used for login.

string

required

One-time password code.

Response body fields

string

optional

JWT bearer token for authenticated requests.

string

optional

Refresh token for renewing the session.

ISODateString

optional

Token expiry timestamp when supplied by Linxio.

Request

curl -X POST https://api.linxio.com/api/login/otp \
  -H "Content-Type: application/json" \
  --data '{
    "email": "user@example.com",
    "code": "123456"
  }'

Example response


{
  "token": "jwt_token",
  "refreshToken": "refresh_token",
  "expireAt": "2026-06-08T12:00:00+08:00"
}

POST /token/refresh

POST

Refresh JWT auth token

/token/refreshlinxio.auth.refresh(refreshToken)

Exchanges a refresh token for a new JWT token.

Request headers

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Refresh token returned by login or a previous refresh call.

Response body fields

string

optional

New JWT bearer token.

string

optional

New refresh token when Linxio rotates it.

ISODateString

optional

Token expiry timestamp when supplied by Linxio.

Request

curl -X POST https://api.linxio.com/api/token/refresh \
  -H "Content-Type: application/json" \
  --data '{
    "refreshToken": "refresh-token"
  }'

Example response


{
  "token": "jwt_token",
  "refreshToken": "refresh_token",
  "expireAt": "2026-06-08T12:00:00+08:00"
}

GET /me

GET

Get current user

/melinxio.auth.me(fields)

Returns the current authenticated user.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

string[]

optional

Optional field projection for the current-user response.

Response body fields

LinxioId

optional

Current user ID when supplied.

string

optional

Current user email when supplied.

string

optional

Current user display name when supplied.

string

optional

Current team type when supplied.

string[]

optional

Permission keys when supplied.

object

optional

Current team details when supplied.

Request

curl "https://api.linxio.com/api/me?fields[]=id&fields[]=email" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "id": 64553,
  "email": "user@example.com",
  "fullName": "Example User",
  "teamType": "string",
  "permissions": [
    "string"
  ],
  "team": {
    "id": 5932,
    "type": "client",
    "clientId": 5598,
    "resellerId": null,
    "resellerName": null,
    "clientName": "EXAMPLE CLIENT"
  }
}

POST /logout

POST

Log out current session

/logoutlinxio.auth.logout()

Logs out the current session server-side.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

void

optional

Send an empty JSON object or no body.

Response headers

204 or JSON

optional

Linxio may return an empty success response.

Authentication

POST /login

Create a session

Request headers

Request body parameters

Response body fields

POST /login/otp

Verify one-time password

Request headers

Request body parameters

Response body fields

POST /token/refresh

Refresh JWT auth token

Request headers

Request body parameters

Response body fields

GET /me

Get current user

Request headers

Request query parameters

Response body fields

POST /logout

Log out current session

Request headers

Request body parameters

Response headers

On this page