SysAid’s API uses Client Credentials authentication with a two-step process. Here’s how to authenticate and start calling our API endpoints securely.

📘

Before you start:

• You must use your SysAid account credentials and not SSO credentials to generate an ccess token. You can find them by going to your user profile in SysAid.
• Authentication is limited to one SysAid account at a time - the generated access token will only be able to access data from that specific account.

Step #1: Create an application key

Use the Create an App Key endpoint to send a POST request to v1/application-keys.

Header:

Body:

 {
  "userName": "your_username",
  "password": "your_password",
  "applicationName": "optional app name",
  "description": "optional description",
  "tokenLifetime": 0
}

🕙 The tokenLifetime parameter value is in seconds. The default is 86400 (24 hours). You can change it by inserting the lifetime value in seconds you’d like the token to expire after. For example, for 48 hours, set it to 172800.
The maximum allowed value is 2592000 (30 days).

Response:

{
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret",
  "applicationName": "your app name"
}

🔐 You only need to do this once. If you lose your credentials, you can repeat the process to regenerate them.

Step #2: Generate an access token

Use the Generate Access Token endpoint to send a POST request to /v1/access-tokens.

Header:

Body:

{
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret"
}

Response:

{
  "token": "your-access-token",
  "tokenType": "Bearer",
  "expiresIn": 86400
}

📍 The expiresIn parameter shows how long the token will remain valid (in seconds).
You can generate a new access token anytime using your clientId and clientSecret.