Support API specification (1.17.0)

Download OpenAPI specification:Download

The support service implements a way for our support agents to transparently work with the customer in their organization

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: Personal-Access-Token

support

AllowAccess

Used by organizations admins to give our support access to their organization

path Parameters
organizationID
required
int64

Responses

200

access was allowed

400

organization id is missing or in a wrong format

500

unexpected database error

put /organization/{organizationID}
https://app.groupalarm.com/api/v1/support/organization/{organizationID}

DisallowAccess

Used by organizations admins to remove our support's access to their organization

path Parameters
organizationID
required
int64

Responses

200

access was removed

400

organization id is missing or in a wrong format

500

unexpected database error

delete /organization/{organizationID}
https://app.groupalarm.com/api/v1/support/organization/{organizationID}