List Compliance User Groups
List compliance user groups matching a set of filters. Released in 1.55.3
Query parameters
typestringRequired
areastringOptional
namestringOptional
activebooleanOptional
afterstringOptional
beforestringOptional
sortstringOptional
limitintegerOptional
Max number of records to return.
Header parameters
sessionTokenstringRequired
Session authentication token.
Responses
200
Success
application/json
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
500
Server error, see response body for further details.
application/json
get
GET /pod/v2/admin/usergroups?type=text HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*
{
"data": [
{
"id": "text",
"name": "text",
"area": "text",
"description": "text",
"type": "text",
"active": true,
"createdDate": 1,
"modifiedDate": 1,
"memberCount": 1,
"assigneeCount": 1
}
],
"pagination": {
"cursors": {
"before": "MTAxNTExOTQ1MjAwNzI5NDE=",
"after": "NDMyNzQyODI3OTQw"
},
"previous": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&before=MTAxNTExOTQ1MjAwNzI5NDE=",
"next": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&after=NDMyNzQyODI3OTQw"
}
}
🚧 Scoping groupsScoping groups are used to manage the set of users and conversations that Compliance Officers or Super Compliance Officers have access to.
📘 NoteA compliance group must exactly match all of the specified query parameters to be included in the results.
🚧 Roles and PrivilegesCalling 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.
Last updated
Was this helpful?