Get a Compliance User Group

Returns a compliance user group.Released in 1.55.3

Get a user group

get

Path parameters

groupIdstringRequired

ID of the group

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

User Group returned successfully.

application/json

Group object response

idstringOptional

Group ID

namestringOptional

Group name

areastringOptional

An optional string attribute used for categorizing groups

descriptionstringOptional

Group description

typestringOptional

Group type

activebooleanOptional

Group status

createdDateinteger · int64Optional

Date of group creation

modifiedDateinteger · int64Optional

Date of group last update

memberCountinteger · int64Optional

Number of group members

assigneeCountinteger · int64Optional

Number of group assignees

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

User Group returned successfully.

application/json

500

Server error, see response body for further details.

application/json

get/v2/admin/usergroups/{groupId}

GET /pod/v2/admin/usergroups/{groupId} HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "id": "text",
  "name": "text",
  "area": "text",
  "description": "text",
  "type": "text",
  "active": true,
  "createdDate": 1,
  "modifiedDate": 1,
  "memberCount": 1,
  "assigneeCount": 1
}

🚧 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.