Get User Groups
get
/api/AAA/UserGroups
Gets the user groups that match the specified parameters. If no parameters are specified, all user groups are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAAUserGroupsRead
Type:
Show Source
object
-
Preferences: array
Preferences
The user group preferences.
-
Properties: array
Properties
The user group properties.
-
RoleID: integer
The role ID.Example:
1
-
RoleName: string
The role name.Example:
Administrator
-
UserGroupID: integer
The user group ID.Example:
1
-
UserGroupName: string
The user group name.Example:
Administrators
-
Users: array
Users
The users in the group.
Nested Schema : items
Type:
Show Source
object
-
Description: string
The preference description.Example:
Default pagination setting for grid views (default 1000)
-
Override: integer
Example:
0
-
PreferenceID: integer
The preference ID.Example:
2
-
PreferenceName: string
The preference name.Example:
PageSize
-
PreferenceValue: integer
The preference value.Example:
1000
Nested Schema : items
Type:
Show Source
object
-
Description: string
The property description.Example:
Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups
-
PropertyID: integer
The property ID.Example:
1
-
PropertyName: string
The property name.Example:
RestrictiveDeviceGroupID
-
PropertyValue: integer
The property value.Example:
1
Nested Schema : items
Type:
Show Source
object
-
UserID: integer
The user ID.Example:
1065
-
UserName: string
The user name.Example:
Operator
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object