EIeightfold
User Groups

Assign User Group Members

Changed on

Assigns users to a user group. Additive: users already in the group are reported back in existingUsers and left untouched, so the call is safe to retry. Every id is validated before any is written, so one bad id rejects the whole request. Candidate and deleted accounts cannot be assigned, and system user groups are refused because their membership is derived from roles.

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

Request

Path parameters

userGroupIdstring required

ID of a user group in Eightfold

Headers

Authorizationstring required

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

Request body

userIdsinteger[] required

Ids of the users to assign, at most 100 per request. Every id is validated before any is written, so one bad id rejects the whole request

Response

OK

createdAtinteger nullable

Create timestamp of the user group

idinteger nullable

Id of the user group

isActiveboolean nullable

Whether the user group is active

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