EIeightfold
User Groups

Create User Group

Changed on

Creates a user group. userGroupName must be unique within the tenant, ignoring case and surrounding whitespace. Access criteria and dynamic membership rules cannot be set through this API. Members are assigned through the user group membership APIs.

post/api/v2/core/user-groups

Request

Headers

Authorizationstring required

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

Request body

createdAtinteger nullable

Create timestamp of the user group

idinteger nullable

Id of the user group

isActiveboolean

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 required

Name of the user group. Must be unique within the tenant, ignoring case

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