v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB

Authentication

Create App Key

Create a unique set of credentials (Client ID and Client Secret) for authenticating with the API. These credentials are required to request an access token and should be securely stored. Each user must generate their credentials before interacting with the API.

post/application-keys

Headers

x-sysaid-accountidstring required

SysAid account identifier

SysAid account identifier.

Request body

userNamestring required

The user name you use when signing into your SysAid account.

passwordstring required

The password you use when signing into your SysAid account.

applicationNamestring required

This action creates an app entity for the user. You can choose a specific name for it.

tokenLifetimeinteger

The time in seconds until tokens generated with these credentials expire. The default is 86400 (24 hours), maximum value is 2592000 (30 days).

descriptionstring

Additional information about this app or user (optional)

Response

Application key created successfully

clientIdstring required

The client ID to use for authentication.

clientSecretstring required

The client secret to use for authentication (only shown once).

applicationNamestring required

The name of the application.

All 89 operations