Supported Regions and Base URLs
Access and RegistrationAuthentication
Scope
guardian-users:read
Body Response - Schema
200 (paginated list of agent role changes)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | array[object] | "_embedded" subdivides into: 1 - "assigned_at" (string) - the role attribution timestamp. 2 - "assigned_by" (string) - the agent name that did the role attribution. Example: 3 - "role" (string) - the agent role. Example: 4 - "id" (string) - the user ID. Example: | no |
| _links | object | "_links" subdivides into: 1 - "first" (object) - the first page link. 2 - "last" (object) - the last page link. 3 - "next" (object) - the next page link. 4 - "prev" (object) - the previous page link. 5 - "self" (object) - the current page link. 6 - "show" (object) - show alarms link. | no |
| count | integer<int32> | The number of results in the current page. Example: 10 | no |
| page | integer<int32> | The current page. Example: 10 | no |
| per_page | integer<int32> | The number of results per page. Example: 10 | no |
| total | integer<int64> | The total number of results. Example: 10 | no |
| total_page | integer<int64> | The total number of pages. Example: 5 | no |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 406 (not acceptable)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
TroubleshootingIf you have any questions regarding the usage of this API, or if youāre having any technical issues, please open a ticket using this form.