EIeightfold
User Groups

List User Group Members

Changed on

Returns the members of a user group. Assigned members are read from the database, so an assignment is visible immediately; members matched by the group's rules are read from the search index and can lag a recent change. Every member carries a membershipType, and only static members can be removed.

get/api/v2/core/user-groups/{userGroupId}/users

Request

Path parameters

userGroupIdstring required

ID of a user group in Eightfold

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

membershipTypestring

Filter to static (explicitly assigned) or dynamic (matched by the group's rules) members. Defaults to all. Use static to skip the search index query entirely.

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

Changes