Update a User Group
put
/api/AAA/UserGroups/{id}
Updates the properties of the user group that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The user group ID.Example:
1
Supported Media Types
- application/json
Root Schema : schema
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
-
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:
1
-
PreferenceID: integer
The preference ID.Example:
2
-
PreferenceName: string
The preference name.Example:
PageSize
-
PreferenceValue: integer
The preference value.Example:
1000
-
Required: boolean
Whether the field is required (true) or not (false).Example:
false
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
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
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