List Compliance Group Memberships

Filters and lists compliance group memberships for a user. Released in 1.55.3

Filter and list Group Memberships for an user.

get

/v2/admin/users/{userId}/groupmemberships

Path parameters

userIdinteger · int64required

Query parameters

groupTypestring · enumrequired

Options: ROLE_SCOPE, CEP_VISIBILITY_GROUP

groupIdstring

activeboolean

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v2/admin/users/{userId}/groupmemberships?groupType=ROLE_SCOPE' \
  --header 'sessionToken: text'

200

400

401

403

404

422

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
    }
  ]
}

OK

🚧 Roles and Privileges

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

📘 Note

limit query parameter: 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 as described in the following example: If you set 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.

sort query parameter: if the name of the field is preceded by a "-", then the results will be returned in descending order, otherwise results will be returned in ascending order. For example, a sort param value of "-name" would return results sorted by the "name" field in descending order, while a value of "name" would return results sorted by the "name" field in ascending order. The fields available for sorting are "lastAddedDate" and "lastRemovedDate".