EIeightfold
User Groups

Patch User Group

Changed on

Updates a user group. Send only the fields to change; anything omitted is left untouched. Access criteria and dynamic membership rules cannot be set through this API. Renaming a group changes what the SCIM APIs report for it, since those identify a group by name.

patch/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

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 nullable

Name of the user group

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