/createUserGroup

1 min

POST

/createUserGroup

Add a new user group to the MPC user management so that admins will be able to include this group in the relevant policies.

Input Example:

.. code-block::

createUserGroup( id="2376234", name="user group name", viewPermissionSetId="0", UserIds=["[email protected]", "[email protected]"], request_extra_data={ "MessageNumber": 5, "SessionId": "3478593863424051983840947" } }

Response Example

 {
    "FunctionData": {
        "StatusCode": 0,
        "StatusCodeDescription": "User group created successfully"
    },
    "Meta": {
        "AccessToken": "2911...9a7",
        "Destination": "04bc...9e2",
        "Source": "3dcf...ba4",
        "Time": "2025-05-22 17:00:44.605"
    }
}

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	User group already exists	"StatusCode": 1
Backend Response	400	2	User group name already exists	"StatusCode": 2
Backend Response	400	3	Invalid name	"StatusCode": 3
Backend Response	400	4	Unknown view permission set ID	"StatusCode": 4
Backend Response	400	5	Unknown user	"StatusCode": 5, "UserIds": ["[email protected]", "[email protected]"]
Backend Response	400	6	Invalid policy	"StatusCode": 6, "PolicyIds": ["test1", "test2"]
Backend Response	400	7	Invalid approval workflows	"StatusCode": 7, "ApprovalWorkflowIds": ["6", "9"]
Backend Response	400	8	Duplicate user	"StatusCode": 8 , "UserId": "[email protected]"
Backend Response	400	9	Insufficient available account approvers	"StatusCode": 9, "UserIds": ["[email protected]"]
Backend Response	400	10	Invalid transaction notification users	"StatusCode": 10, "UserIds": ["[email protected]"]
Backend Response	400	11	Users are managed externally	"StatusCode": 11, "UserId": "[email protected]"
Backend Response	400	12	Cannot edit system user group	"StatusCode": 12

idstringa unique id for the new user group

namestringa unique 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

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/createUserGroup?id=123&name=2376234&view_permission_set_id=0&user_ids=array&request_extra_data={%0A%20%20%22MessageNumber%22%3A%205%2C%0A%20%20%22SessionId%22%3A%20%223478593863424051983840947%22%0A}%0A' \
     --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"
     }
     }'