| Header | Value |
|---|---|
| ClientID |
This is required for all API requests made |
| ClientSecret |
This is only required on the auth/AccessToken endpoint to generate an AccessToken |
Authentication is required on all endpoints. This is done via HTTP headers in the form of an AccessToken and ClientID.
To generate an AccessToken you are required to do a POST request to the /api/auth endpoint with the Headers of "ClientID" and "ClientSecret".
If successful, you will have an AccessToken returned with an expiry date.
/api/auth/AccessToken| Header | Value |
|---|---|
| ClientID |
This is required for all API requests made |
| ClientSecret |
This is only required on the auth/AccessToken endpoint to generate an AccessToken |
{
"Results": [
{
"AccessToken": "fj4DTgjwlk42FH....",
"Expiry": "2021-04-23T18:25:43.511Z"
}
]
}
| Header | Value |
|---|---|
| ClientID |
This is required for all API requests made |
| AccessToken |
This is the value of the returned AccessToken |
To invalidated an AccessToken you can make a POST request to the following endpoint: /api/auth/AccessToken/invalidate including the ClientID and AccessToken headers.
If successful, you will no longer be able to use the AccessToken for any API requests.
To request access to IBMS Cloud use the following link: Email Request