EIeightfold
User Groups

Get User Group

Changed on

Given a user group id, it returns the user group along with its member counts. staticMemberCount is read from the database and is always current; dynamicMemberCount is read from the search index, can lag a recent change, and is null if that index cannot be reached, which is distinct from a count of zero.

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

Request

Path parameters

userGroupIdstring required

ID of a user group in Eightfold

Query parameters

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

createdAtinteger nullable

Create timestamp of the user group

idinteger nullable

Id of the user group

staticMemberCountinteger nullable

Number of users explicitly assigned to the user group

isActiveboolean nullable

Whether the user group is active

dynamicMemberCountinteger nullable

Number of users matching the dynamic membership rules of the user group. Null if the search index could not be reached, which is distinct from a count of zero

descriptionstring nullable

Description of the user group

productLinestring nullable

Product line this user group applies to. Defaults to all product lines

updatedAtinteger nullable

Update timestamp of the user group

rolestring nullable

Role granted to the members of the user group

userGroupNamestring nullable

Name of the user group

Changes