The Access Groups group provides operations that are retrieving the different access groups available.
Description Fetch all access groups
Response Class
PagedAccessGroupResponse
{
TotalCount (long),
ResultsPerPage (int),
Page (int),
Errors (string),
Results (Array[AccessGroupResponse])
}
AccessGroupResponse
{
Id (Guid),
Name (string),
Description (string),
Buildings (Array[Building])
}
Guid {}
Building
{
Id (Guid),
Name (string),
BuildingIdentifier (string)
}
| Parameter | Description | Data Type |
|---|---|---|
| Page | Requested page number | integer |
| ResultsPerPage | Requested page size, max 250 | integer |
| SortBy | Sort by: Name, Description | string |
| SortDirection | Order direction : DESC, ASC | string |
Description Get access groups with a list of managing ACR/ACRMs
Response Class
AccessGroupWithManagers {
AccessGroup (AccessGroup),
AccessManagers (Array[Identity])
}
AccessGroup {
Id (Guid),
Name (string),
Description (string),
IsAutoApproved (boolean)
}
Guid {}
Identity {
Id (Guid),
FirstName (string),
LastName (string),
EmployeeNumber (string),
Email (string),
Roles (string),
AcrmEmployeeNumber (string),
ManagersEmployeeNumber (string)
}
| Parameter | Description | Data Type |
|---|---|---|
| AccessGroups | List of access group ids | string |
| IncludeAutoApproved | Include access groups managed by Auto Approved rule | bool |
Description Search for access groups
Response Class
PagedAccessGroupResponse {
TotalCount (long),
ResultsPerPage (int),
Page (int),
Errors (string),
Results (Array[AccessGroupResponse])
}
AccessGroupResponse {
Id (Guid),
Name (string),
Description (string),
Buildings (Array[Building])
}
Guid {}
Building {
Id (Guid),
Name (string),
BuildingIdentifier (string)
}
| Parameter | Description | Data Type |
|---|---|---|
| Page | Requested page number | integer |
| ResultsPerPage | Requested page size, max 250 | integer |
| Search | Search term looking at access-group name, description, building info, and tags | string |
| BuildingIdentifierFilter | Filter results down to specific building by Building Identifier | string |
| SortBy | Sort by: Name, Description | string |
| SortDirection | Order direction : DESC, ASC | string |