Getting Started

Here’s how to get started with the Partner Application

Create a Partner Application

  1. Log into the Multi-Tenant Console, select Settings, then select Application.
  2. Click Add New Application.
  3. Enter a name and privileges.
  4. Click Submit.
  5. Copy Application ID (Guid) and Application Secret (Hash) to a text file.
    • If you lose the Application Secret, you will have to regenerate a new one. This cannot be retrieved from the MTC application.
  6. Click OK.

Generate a Bearer Token

  1. Import the example JSON file into Postman.
  2. Select the /{region}/auth endpoint.
    • {{baseUrl}} is https://api-admin.cylance.com/public.
    • Full URL for the US login region would be https://api-admin.cylance.com/public/us/auth.
  3. Click on the Params Tab.
  4. Under Path Variables set key region to your MTC Login Region.
  5. Click on the Authorization Tab.
  6. Select Basic Auth from the Type drop down.
  7. Enter your Application ID as Username and your Application Secret as Password.
    • Under the Headers Tab, in the Temporary Headers drop down you should see an Authorization header with a value of Basic {base64Hash}.
  8. Click on the Body Tab.
  9. The x-www-form-urlencoded radio button should be selected.
  10. Set the key grant_type to value client_credentials.
  11. Set the key scope to value api.
  12. Click Send.
  13. The API will respond with a 200 response code and a token response object as the following:
{
	"access_token": string,
	"expires_in": int,
	"token_type": string
}
  1. The access_token will be used in all subsequent calls as the Bearer token.

Making Your First Call to Health Check

  1. Select the /{region_code}/health-check endpoint.
    • {{baseUrl}} is https://api-admin.cylance.com/public.
    • region_code is the MTC region you sign into.
    • Full URL for the US login region would be https://api-admin.cylance.com/public/{region_code}/health-check.
  2. Click on the Authorization Tab.
  3. Select Bearer Token from the Type drop down.
  4. Paste the access_token you generated previously.
  5. Click Send.
  6. You should receive 200 response code and string return like the following:
{
   "Version": x.x.x.x | Environment: 'Production'"
}

Site last modified on November 17, 2021