Authentication

Authenticate

post

Exchange API Key credentials for JWT tokens

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

workspacestringRequired

Target workspace

apiKeyIdstringRequired

API Key id

apiKeySecretstringRequired

API Key secret

Responses

200

Successful response

application/json

accessTokenstringRequired

JSON Web Token used to authenticate requests

expiresInSecondsnumberRequired

JWT validity period (in seconds)

refreshTokenstringRequired

Refresh token used to obtain new JWT

refreshExpiresInSecondsnumberRequired

Refresh token validity period (in seconds)

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/auth/token

HTTPcURLJavaScriptPython

POST /v1/rest/auth/token HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "workspace": "text",
  "apiKeyId": "text",
  "apiKeySecret": "text"
}

{
  "accessToken": "text",
  "expiresInSeconds": 1,
  "refreshToken": "text",
  "refreshExpiresInSeconds": 1
}

Refresh token

post

Exchange refreshToken for JWT tokens

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

workspacestringRequired

Target workspace

refreshTokenstringRequired

Refresh token

Responses

200

Successful response

application/json

accessTokenstringRequired

JSON Web Token used to authenticate requests

expiresInSecondsnumberRequired

JWT validity period (in seconds)

refreshTokenstringRequired

Refresh token used to obtain new JWT

refreshExpiresInSecondsnumberRequired

Refresh token validity period (in seconds)

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/auth/token/refresh

HTTPcURLJavaScriptPython

POST /v1/rest/auth/token/refresh HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "workspace": "text",
  "refreshToken": "text"
}

{
  "accessToken": "text",
  "expiresInSeconds": 1,
  "refreshToken": "text",
  "refreshExpiresInSeconds": 1
}