Read All Group Memberships for User
GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/memberOfGroups?expand=group&limit=100&filter=type%20eq%20%22DIRECT%22
The GET /environments/{{envID}}/users/{{userID}}/memberOfGroups operation returns all groups that the specified user is a member of.
For more information about groups, see Groups.
| Parameter | Description |
|---|---|
expand (string) | Possible value is group. When this parameter is appended to the request, the results are expanded to include additional information about each group. |
limit (int) | The maximum number of results returned per page. |
filter (string) | A SCIM filter. For more information, see Filtering groups searches. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
expand | string | ||
limit | number | ||
filter | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/memberOfGroups?limit=100\u0026expand=group"}},"_embedded":{"groupMemberships":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/memberOfGroups/65631016-ecfc-4ba6-8cc0-bcc548eb58e2"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/65631016-ecfc-4ba6-8cc0-bcc548eb58e2"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"group":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/65631016-ecfc-4ba6-8cc0-bcc548eb58e2"}},"_embedded":{"group":{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/memberOfGroups"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"allUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%3D%2265631016-ecfc-4ba6-8cc0-bcc548eb58e2%22%5D"},"directUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%3D%2265631016-ecfc-4ba6-8cc0-bcc548eb58e2%22%20and%20type%20eq%20%22DIRECT%22%5D"}},"id":"65631016-ecfc-4ba6-8cc0-bcc548eb58e2","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Training","description":"This is a test group","customData":{"groupOwner":"Jane Doe","securityyGroup":false},"createdAt":"2020-11-10T21:42:55.219Z","updatedAt":"2020-11-10T21:42:55.219Z"}},"id":"65631016-ecfc-4ba6-8cc0-bcc548eb58e2","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Training","type":"DIRECT"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/memberOfGroups/e947cec5-62c5-4d80-af16-497b29e8a685"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e947cec5-62c5-4d80-af16-497b29e8a685"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"group":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/e947cec5-62c5-4d80-af16-497b29e8a685"}},"_embedded":{"group":{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/c98fd0cc-c34b-406a-9e0b-a892edb7a702/memberOfGroups"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"allUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%3D%22e947cec5-62c5-4d80-af16-497b29e8a685%22%5D"},"directUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%3D%22e947cec5-62c5-4d80-af16-497b29e8a685%22%20and%20type%20eq%20%22DIRECT%22%5D"}},"id":"e947cec5-62c5-4d80-af16-497b29e8a685","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Managers","description":"This is a test group","customData":{"groupOwner":"Sally Manager","securityyGroup":true},"createdAt":"2020-11-19T16:24:35.966Z","updatedAt":"2020-11-19T16:24:35.966Z"}},"id":"e947cec5-62c5-4d80-af16-497b29e8a685","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Managers","type":"DIRECT"}]},"count":2,"size":2}