The GET /environments/{{envID}}/users
operation returns a list of all user resources for the specified environment. Use the limit
query parameter to restrict the number of users returned. You can also use SCIM filtering as a query parameter or parameters to return specific information for a user or users.
You must have the Identity Data Admin role to read group membership. For more information about groups, see Groups.
The second response example shows the simple case of returning a single user based on their username
property. The request looks like this: GET {{apiPath}}/environments/{{envID}}/users?filter=username eq "wingar_helena"
.
See Limiting and Filtering Data for information about the supported SCIM operators and the limit
parameter.
Parameter | Description |
---|---|
expand=population |
Returns information about the user’s population assignment. |
filter=<supportedPropFilter> |
Filters for users with the designated attribute. See Limiting and filtering data and Users data model for more information. |
filter=memberOfGroups[id eq "{{groupID}}"] |
Filters results for group membership. |
filter=syncedStores[store.id eq {{storeID}} and status eq {{storeStatus}}] |
Filters the results for those users being provisioned from synced stores. |