REST API Reference

Back Next

Getting user group details

You can request the details for all user groups in the organization or request the details for a particular user group.

GET request

You can request the details for all user groups in the organization or request the details for a particular user group.

To get user group details, use the following URI:

/public/core/v3/userGroups

To get the details for a particular user group, you can include the following query parameters in the URI:

Parameter	Type	Description
q	String	Query filter. You can filter using one of the following fields: userGroupId. Unique identifier for the user group. userGroupName. Name of the user group.
limit	Int	Maximum number of user groups to return. Default is 100.
skip	Int	Amount to offset the list of results. Default is 0.

For example, to get details for a particular user group using the user group's name, you might use the following request:

public/core/v3/userGroups?q=userGroupName=="group_a"

GET response

If successful, returns the following information for each user group:

Field	Type	Description
id	String	User group ID.
orgId	String	ID of the organization the user group belongs to.
createdBy	String	User who created the user account.
updatedBy	String	User who last updated the user account.
createTime	String	Date and time the user group was created.
updateTime	String	Date and time the user group was last updated.
userGroupName	String	Name of the user group.
description	String	Description of the user group.
roles	Array	Roles assigned to the user group.
id	String	Included in the roles object. Role ID.
roleName	String	Included in the roles object. Role name.
description	String	Included in the roles object. Description of the role.
displayName	String	Included in the roles object. Role name that is displayed in the user interface.
displayDescription	String	Included in the roles object. Role description that is displayed in the user interface.
users	Array	Users assigned to the user group.
id	String	Included in the users object. User ID.
userName	String	Included in the users object. User name.
description	String	Included in the users object. Description of the user.

GET response example

If successful, you might receive a response similar to the following example:

[
    {
        "id": "a6x85hoMvH2kWUIlcIRBEh",
        "orgId": "cPYWk02I4aBeuLEvYRtaMS",
        "createdBy": "a@abc.com",
        "updatedBy": "a@abc.com",
        "createTime": "2019-03-19T17:27:09.000Z",
        "updateTime": "2019-03-19T17:27:09.000Z",
        "userGroupName": "group_a",
        "description": "",
        "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."
            }
        ],
        "users": [
            {
                "id": "5N9JGth6pRYfOGjGKv3Q2D",
                "userName": "a@abc.com",
                "description": ""
            }
        ]
    }
]

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting user group details

Getting user group details

GET request

GET response

GET response example