Get a Compliance User Group

Returns a compliance user group.Released in 1.55.3

Get a user group

GETyourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}

Path parameters

groupId*string

ID of the group

Header parameters

Response

200400401403404500

User Group returned successfully.

Body

application/json

idstring

Group ID

namestring

Group name

areastring

An optional string attribute used for categorizing groups

descriptionstring

Group description

typestring

Group type

activeboolean

Group status

createdDateinteger (int64)

Date of group creation

modifiedDateinteger (int64)

Date of group last update

memberCountinteger (int64)

Number of group members

assigneeCountinteger (int64)

Number of group assignees

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "area": "text",
  "description": "text",
  "type": "text",
  "active": false
}

🚧 Roles and Privileges

Calling this endpoint requires the Scope Management role with the VIEW_ROLE_SCOPES entitleable action. See Bot Permissions for a list of roles and associated privileges.