REST API Reference

Back Next

Creating a user group

If you have administrator privileges, you can use the userGroups resource to create a user group.

The number of users, user groups, and roles combined cannot exceed 1000 for an organization.

POST request

To create a user group, send a POST request using the following URI:

/public/core/v3/userGroups

Include the following information:

Field	Type	Required	Description
name	String	Yes	Name of the user group.
description	String	-	Description of the user group.
roles	Array	Yes	IDs of the roles to assign to the user group.
users	Array	-	IDs of the users to assign to the user group.

POST response

If successful, returns the userGroups object with the details you included in the POST request.

POST example

To create a user group, you might send a request similar to the following example:

POST <baseApiUrl>/public/core/v3/userGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name" : "user_group_1",
    "roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"],
    "users" : ["9EcgvBYZ9GGflOYr98GzOH"]
}

You might receive a response similar to the following example:

{
    "id": "0TLmCMwX0jNdJ5SzlQC2CW",
    "orgId": "cPYWk02I4aBeuLEvYRtaMS",
    "createdBy": "a@abc.com",
    "updatedBy": "a@abc.com",
    "createTime": "2019-03-20T18:30:32.457Z",
    "updateTime": "2019-03-20T18:30:32.472Z",
    "userGroupName": "user_group_1",
    "description": null,
    "roles": [
        {
            "id": "9gedBDoYQoQibNMohf5KCh",
            "roleName": "Admin",
            "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
            "displayName": "Admin",
            "displayDescription": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
        },
        {
            "id": "5IPgtye09EbiWqz5XXuzwC",
            "roleName": "test_user_1",
            "description": ""
            "roleName": "test_user_1",
            "description": ""
       }
    ],
    "users": [
        {
            "id": "9EcgvBYZ9GGflOYr98GzOH",
            "userName": "test_user_2",
            "description": null
        }
    ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Creating a user group

Creating a user group

POST request

POST response

POST example