Patch User Group

patch

https://apiv2.{domain}.ai/api/v2/core/user-groups/{userGroupId}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userGroupId

string

required

ID of a user group in Eightfold

Query Params

exclude

string

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.

keyList

string

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.

Body Params

isActive

boolean

Whether the user group is active

description

string | null

Description of the user group

productLine

string | null

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

role

string | null

Role granted to the members of the user group

userGroupName

string | null

Name of the user group

Headers

Authorization

string

required

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

Response

200OK