Authentication

Finding Your Authentication Credentials

Head to the backend of your website to obtain the credentials

1. Classic Sites (webdriver)
   1. Login to webdriver
   2. Click on “API Manager” -> “App Authorizations” -> “Manage”
   3. Click “View” under the actions column for the resource you’d like the credentials for
   4. Your credentials are under the “Authorization Information” section and are passed to the Authentication endpoint below to retrieve your token
2. New CIMCloud platform (worker portal)
   1. Login to the Worker Portal
   2. Search for App Authorizations and click on the menu link
   3. Click “View” under the actions column for the resource you’d like the credentials for
   4. Your credentials are under the “Authorization Information” section and are passed to the Authentication endpoint below to retrieve your token

Please Note: Your Authorization Password is hashed and can only be reset (i.e. we cannot retrieve the current authorization password since it is not stored in a plaintext format).  You should make note of the Authorization Password used on creation, or reset, to minimize disruptions.

Authentication Requests

Description: Requests generate an authentication token, which expire after 7 days from creation.  This is an authentication type of “Bearer Token” and must be passed with each corresponding HTTP request (excluding the canary endpoint).  There is no limit on the number of generated bearer tokens (i.e. you can authenticate and generate a bearer token as often as you’d like).

HTTP Method: POST

Endpoint: https://api.cimcloud.com/{sitename}/authenticate

Body (set the values obtained from the Finding Your Authentication Credentials section above):

{
"AuthKey": "xxxxxxxxxxx",
"AuthUserName": "xxxxxxxxxxx",
"AuthPassword": "xxxxxxxxxxx"
}

Successful Response:

{
"expiration": "2022-01-01T01:00:00Z",
"token": "xxxxxxxxxxx"
}