Update User Group
Update a specific user group
Request
URI
PUT
https://{api_host}/api/v2/usergroup/{id}
COPY
Path Parameters
string
id
Required
id
Request Body
Example Body:
{
"id": "UserGroup identifier",
"name": "UserGroup name",
"roleIDs": [
"role1",
"role2",
"role3"
],
"description": "UserGroup description"
}
UserGroupWrite of type(s) application/json
Optional
{
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"customer": "string",
"roleIDs": [
"string"
]
}string
name
Required
The name of the user group
string
id
Optional
The unique identifier of the user group
string
description
Optional
The description of the user group
integer As int64 As int64
createdEpochMillis
Optional
createdEpochMillis
string
customer
Optional
The id of the customer to which the user group belongs
array of string
roleIDs
Required
List of role IDs the user group has been linked to.
Responses
200
successful operation
Returns ResponseContainerUserGroupModel of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"users": [
"string"
],
"userCount": 0,
"properties": {
"nameEditable": false,
"usersEditable": false,
"rolesEditable": false
},
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": 0,
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": 0,
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": false,
"usersRemovable": false,
"usersAddable": false,
"permsEditable": false,
"deletable": false
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"roleCount": 0,
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"customer": "string"
}
}