Support API specification (2.14.1)
Download OpenAPI specification:Download
The support service implements a way for our support agents to transparently work with the customer in their organization
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 |
AllowAccess
Used by organizations admins to give our support access to their organization
path Parameters
| organizationID required | int64 |
Responses
access was allowed
organization id is missing or in a wrong format
unexpected database error
DisallowAccess
Used by organizations admins to remove our support's access to their organization
path Parameters
| organizationID required | int64 |
Responses
access was removed
organization id is missing or in a wrong format
unexpected database error