Skip to main content
You are reading the docs of Galtea 5.15. Read this page in the latest version.
Only an OWNER or ADMIN can update a user group.

Returns

Returns the updated User Group object.

Example

Set a permission list

Remove the permission list

Parameters

string
required
The ID of the user group to update.
string
New name for the user group.
string
New description for the user group.
boolean
Links the group to every product of the organization, current and future. A MEMBER, READER or HUMAN_EVALUATOR in the group then reaches every product.
list[string] | None
The product permissions the group grants on its products, each written entity.action, for example analytics.readCoverage. A list replaces the current list, and an empty list grants nothing. Pass None to remove the custom list, so the group grants every permission the role of its members allows. Leave it out to keep the current list. The API answers 400 for an entry that cannot be granted, for an action without the read of its entity, for evaluation.readInference without inferenceResult.read, and for a non-empty list without product.read. See permission lists.