/createUserGroup

1 min

POST

http://1.1.1.1/createUserGroup

NOTE - this function can not be called from Swagger, please use createUserGroupForSwagger instead.
Calling this request can be used for adding a new user group to the MPC user management so that admins will be able to include this group in the relevant policies
Users provided in user_ids that are already in another group will be moved from the previous group to the new group.
return - success or error response.
- Possible status codes:
0 - User group created successfully,

1 - User group already exists,

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 - Duplicate user

idstringid for the new user group

namestringthe name of the new user group

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/createUserGroup?id=123&name=2376234&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": "2376234",
     "Name": "user group name",
     "ViewPermissionSetId": "0",
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "createUserGroup",
     "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 createUserGroupForSwagger instead.
Calling this request can be used for adding a new user group to the MPC user management so that admins will be able to include this group in the relevant policies
Users provided in user_ids that are already in another group will be moved from the previous group to the new group.
return - success or error response.
- Possible status codes:
0 - User group created successfully,
1 - User group already exists,
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 - Duplicate user