List Assignments

List assignments of a compliance group. Released in 1.55.3

List group assignees

get

/v2/admin/usergroups/{groupId}/assignments

Path parameters

groupIdstringrequired

Query parameters

userIdinteger · int64

activeboolean

userRolestring

expandstring

limitinteger

Max number of records to return.

beforestring

afterstring

sortstring

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/assignments' \
  --header 'sessionToken: text'

200

400

401

403

500

200

{
  "pagination": {
    "previous": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&before=MTAxNTExOTQ1MjAwNzI5NDE=",
    "next": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&after=NDMyNzQyODI3OTQw",
    "cursors": {
      "before": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "after": "NDMyNzQyODI3OTQw"
    }
  },
  "data": [
    {
      "id": "text",
      "groupId": "text",
      "group": {
        "id": "text",
        "name": "text",
        "area": "text",
        "type": "text",
        "active": true
      },
      "userId": 1,
      "user": {
        "id": 7215545058329,
        "username": "dpayet",
        "firstName": "Dimitri",
        "lastName": "Payet",
        "emailAddress": "[e-mail]"
      },
      "active": true,
      "lastAddedDate": 1,
      "lastRemovedDate": 1,
      "userRoles": [
        "text"
      ]
    }
  ]
}

Success

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

📘 Note

Certain types of groups support assignment to specific users, which is different from group membership. Assignment of a group can be likened to the assignment of responsibility for that group of users, which will have a different meaning depending on the type of the group. Group assignment is only available for groups of certain types.

Query parameter limit: A query may return fewer than the value of limit due to filtering or service-side maximums. Do not depend on the number of results being fewer than the limit value to indicate your query reached the end of the list of data, use the absence of next instead. For example, if you set the limit to 10 and only 9 results are returned, there may be more data available, but one item was removed due to privacy filtering. Some maximums for limit may be enforced for performance reasons.