Skip to main content
You are reading the docs of Galtea 5.17. 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

Follow a permission preset

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 in the group then reaches every product.
list[string] | None
The permissions the group grants, each written entity.action, for example analytics.readCoverage. A product entry applies to the group’s products, and a metric, model or comment entry across the organization. A list replaces the current list, so the group follows no preset, and an empty list grants nothing. Pass None to make the group follow the EDITOR preset, which 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 a list with a product entry and no product.read, and for an entry without a read of another entity it needs, such as analytics.read without metric.read. See permission lists.
string | UserGroupPermissionPreset | None
The preset the group follows: "EDITOR", "HUMAN_EVALUATOR" or "READER". You can also pass a UserGroupPermissionPreset value. When Galtea changes the preset, the group’s permissions change with it. The user group then reads back permission_preset with that value. For EDITOR, permissions reads back None, which means every permission the role of the members allows. For the other two, permissions reads back the current list of the preset. Do not send permissions together with a preset: the API answers 400. Pass None together with a permissions list to make the group hold its own list. Pass None with no list and the API answers 400. Leave it out to keep the current setting. create has no such parameter: a new group follows EDITOR. See permission lists.