Get authentication token

POST

/api/oauth/v1/token

Authentication

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/oauth/v1/token' \
--header 'Authorization;' \
--header 'Content-type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "access_token": "string",
  "expires_in": 0,
  "refresh_token": "string",
  "scope": "string",
  "token_type": "string"
}

Request

Header Params

Content-type

string

required

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

Authorization

string

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 Client ID/secret generation section.

Body Params application/json

grant_type

string

required

Always equal to "password"

password

string

required

Your PIM password

username

string

required

Your PIM username

Examples

Responses

🟢200Return an authentication token

application/json

Body

access_token

string

optional

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

expires_in

integer

optional

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

refresh_token

string

optional

Use this token when your access token has expired. See Refresh an expired token section for more details.

scope

string

optional

Unused, always equal to "null"

token_type

string

optional

Token type, always equal to "bearer"

🟠400Bad request

🟠415Unsupported Media type

🟠422Unprocessable entity

Modified at 2023-08-15 05:53:55

Get list of all endpoints