/editUserGroup
1 min
POST
http://1.1.1.1/editUserGroup
idstringid of the group requested for editing
namestringthe name of the updated user group or the previous one
view_permission_set_idstring<p>the view permission id for the new group - defines the accounts viewable in the group</p>
user_idsarraydefines the member list for the new group
request_extra_dataobjectadditional data for the administrative request
bodyobject
200success
curl --request POST \
--url 'http://1.1.1.1/editUserGroup?id=123&name=newGroup&view_permission_set_id=0&user_ids=array&request_extra_data=%22{%5Cn%20%20%5C%22MessageNumber%5C%22%3A%205%2C%5Cn%20%20%5C%22SessionId%5C%22%3A%20%5C%223478593863424051983840947%5C%22%5Cn}%5Cn%22' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"FunctionData": {
"Id": "123",
"Name": "user group name",
"ViewPermissionSetId": "0",
"RequestExtraData": {
"MessageNumber": 5,
"SessionId": "3478593863424051983840947"
}
},
"Meta": {
"FunctionName": "editUserGroup",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
}'- NOTE - this function can not be called from Swagger, please use editUserGroupForSwagger instead.
- Calling this request can be used for editing a user group of the MPC user management
- This request will affect the policies and the approval workflows that include this group
- Users provided in user_ids that are already in another group will be moved from the previous group to the new group.
- In case of removing a user from the user_ids list, this user will move to the 'Unassigned' group.
- MPC user created from the cold is editable only in its role and user group
- return - success or error response.
- Possible status codes:
0 - User group edited successfully,
1 - Unknown user group,
2 - User group name already exists,
3 - Invalid name,
4 - Unknown view permission set ID,
5 - Unknown user,
6 - Invalid policy,
7 - Invalid approval workflows,
8 - Users in admin group must have admin role,
9 - Duplicate user,
10 - Cannot rename built-in user group