Sign in

v1

latestOpenAPI 3.0.22026-07-26480119.6 KB
Authentication

Authenticate and receive a JWT token pair

Authenticates a company group using its identifier and auth token. Returns a short-lived JWT access token and an opaque refresh token. The access token must be sent as a Bearer token in subsequent requests.

post/api/v1/login

Request body

identifierstring required

Unique identifier (slug) of the company group

auth_tokenstring uuid required

Secret authentication token of the company group

Example request

{
  "identifier": "my-company-group",
  "auth_token": "cf29470a-73d2-4967-8596-fa3a9e1f552d"
}

Response

Authenticated successfully

access_tokenstring required

Short-lived JWT access token

refresh_tokenstring required

Opaque refresh token for renewing the session

token_typestring required
expires_ininteger required

Access token TTL in seconds (default 86400 = 24 hours)

Example response

{
  "token_type": "Bearer",
  "expires_in": 86400,
  "company_group": {
    "id": 1,
    "identifier": "my-company-group",
    "slug": "my-company-group"
  }
}