Obtain a JWT API token

Returns a JWT token for any active Kubex user when valid credentials are provided. Only tokens for API-enabled users can be used to make authorized API calls.

POST /authorize

cURL

validCredentials

curl --request POST \
  --url https://{host}/api/v2/authorize \
  --header 'Content-Type: application/json' \
  --data '
{
  "userName": "apiUser",
  "pwd": "apiPassword"
}
'

200

{
  "apiToken": "eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiIzNzI2Yzk0NC0wMmE4LTRlYzQtOGE2Ny04ODBmMDM2OTRhZDciLCJpYXQiOjE1NDI2NTI0MDUsInN1YiI6InZhbiIsImlzcyI6IkRlbnNpZnkuY29tIiwiZXhwIjoxNTQyNjUyNzA1fQ.cJd8qFJfRoPnMEU7GzcdYGBT8WwlgmviQ1OQp8P_w9VUcjQA3FJaB9QkqJJ6d7zbrY5yjc4w0rOWjY-PPdbmqw",
  "expires": 1542652705869,
  "status": 200
}

Body

application/json

userName · string · required

Username of an active Kubex user account

pwd · string<password> · required

Password corresponding to userName

Response

200

application/json

Successful authorization

apiToken · string · required

JWT string (RFC 7519) to include as a Bearer token on subsequent requests.

expires · number<int64> · required

Epoch time in milliseconds when the token expires.

status · enum<integer> · required

HTTP status code of the authorization request.

Available options: 200