...
Parameter | Type | Optionality | Description | Example |
grant_type | Form parameter | Required | Must be "client_credentials" | client_credentials |
Authorization | HTTP header | Required | This is a standard HTTP basic authorization header. The value should be a Base64 encoding of your client ID and client secret, concatenated together with a colon (:) separator, and prepended with "Basic ". For example, if your client ID was example_client_id and your client secret was example_secret then your header value should be: Basic ZXhhbXBsZV9jbGllbnRfaWQ6ZXhhbXBsZV9jbGllbnRfc2VjcmV0 | Basic ZXhhbXBsZV9jbGllbnRfaWQ6ZXhhbXBsZV9jbGllbnRfc2VjcmV0 |
Content-Type | HTTP header | Required | Must be "application/x-www-form-urlencoded" | application/x-www-form-urlencoded |
...
Parameter | Type | Optionality | Description | Example |
access_token | JSON parameter | Required | This is the access token that can subsequently be used to authenticate against the relevant API, and gain access to the functionality | eyJhbGxxxx |
token_type | JSON parameter | Required | This is always "bearer" (case may vary) | bearer |
expires_in | JSON parameter | Required | This indicates the number of seconds for which the access_token is valid | 600 |
scope | JSON parameter | Required | Currently, scopes are not supported. As such, this will always be "none". | none |
jti | JSON parameter | Required | A unique identifier for this token. | 24eb74c3-ad03-4c4f-a93d-786cf47b6c2f |
...
Other parameters maybe returned (e.g. scope, jti) - you can safely ignore them. |
Examples
Facade endpoint
| Code Block |
|---|
HTTP/1.1 200 OK
{
"access_token": "abcdef",
"token_type": "bearer",
"expires_in":600 3599,
"scope":"none",
"4e4a5165-af36-40ec-877a-0333cde24490-all",
"client_name": "Your client name",
"jti":"24eb74c3-ad03-4c4f-a93d-786cf47b6c2f"
} |
Customer endpoint
| Code Block |
|---|
HTTP/1.1 200 OK { "access_token": "abcdef", "expires_in": 300, "refresh_expires_in": 0, "token_type": "Bearer", "not-before-policy": 0, "scope": "email profile" } |
Error handling
If the authentication fails, then an error will be returned to you.
...
| Code Block |
|---|
HTTP/1.1 401 Unauthorized
{
"error":"unauthorized"
"error_description":"Full authentication is required to access this resource"
} |
PKB customer sites:deploy |developer |information governance |procurement |manual
...