Read All Groups
GET {{apiPath}}/environments/{{envID}}/groups
The GET /environments/{{envID}}/groups operation returns all groups for an environment.
| Parameter | Description |
|---|---|
filter (String) | A SCIM filter. |
limit (Integer) | The number of results returned per page. |
For more information regarding the query parameters, see Filtering groups searches and Paging, ordering, and filtering collections.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | null | A SCIM filter. See documentation for usage. | |
limit | number | The number of results returned per page. |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=name%20eq%20%22Training%22\u0026limit=10"}},"_embedded":{"groups":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/e195531b-6bc0-435a-96b3-1a377ed7be69"}},"id":"e195531b-6bc0-435a-96b3-1a377ed7be69","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Training","description":"This is a test group","customData":{"groupOwner":"Jane Doe","securityGroup":false},"directMemberCounts":{"users":0,"groups":0},"createdAt":"2022-06-10T17:09:38.200Z","updatedAt":"2022-06-10T17:09:38.200Z","checkSum":"11070448389","userFilter":"title eq \"Training\""}]},"count":1,"size":1}