v1

latestSwagger 2.02026-07-13137761.0 MB

Authentication

Get authentication token

This endpoint allows you to get an authentication token. No need to be authenticated to use this endpoint.

post/api/oauth/v1/token

Headers

Content-typestring required

Equal to 'application/json' or 'application/x-www-form-urlencoded', no other value allowed

Authorizationstring required

Equal to 'Basic xx', where 'xx' is the base 64 encoding of the client id and secret. Find out how to generate them in the <a href="/documentation/authentication.html#client-idsecret-generation">Client ID/secret generation</a> section.

Request body

usernamestring required

Your PIM username

passwordstring required

Your PIM password

grant_typestring required

Always equal to "password"

Example request

{
  "username": "admin",
  "password": "admin",
  "grant_type": "password"
}

Response

Return an authentication token

access_tokenstring

Authentication token that should be given in every authenticated request to the API

expires_ininteger

Validity of the token given in seconds, 3600s = 1h by default

token_typestring

Token type, always equal to "bearer"

scopestring

Unused, always equal to "null"

refresh_tokenstring

Use this token when your access token has expired. See <a href="/documentation/authentication.html#refresh-an-expired-token">Refresh an expired token</a> section for more details.