Skip to main content
PATCH
Update user group
You are reading the docs of Galtea 5.14. Read this page in the latest version.

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Headers

Prefer
string

Send return=minimal to get no body back from a write and skip reading the resource: a create answers 201 with only Location, and an update answers 204.

Example:

"return=minimal"

Path Parameters

id
string
required

User group ID

Example:

"ug_123"

Body

application/json
name
string
Example:

"Example Name"

description
string | null
Example:

"A description"

allProducts
boolean

Grants this group every product of its organization, current and future. Wins over explicit product links while set.

Example:

false

permissions
string[] | null

The product permissions the group grants on its products, each written entity.action, sorted. Null means no custom list: the group grants every permission its members role allows. An empty list grants nothing. A user in several groups may do an action when any group that reaches the product lists it, and the role of the user still limits what a list can grant. Send null to remove the custom list; omit the field to keep it.

Example:

Response

User group updated successfully. The body is the resource as its GET answers it.

id
string
Example:

"ug_123"

organizationId
string
Example:

"org_123"

name
string
Example:

"QA Team"

type
enum<string>
Available options:
EVALUATOR
Example:

"EVALUATOR"

description
string | null
Example:

"Quality assurance team"

createdAt
string<date-time>
userIds
string[]
Example:
metricIds
string[]

Metrics linked to this group. A READER or HUMAN_EVALUATOR caller sees only the linked metrics it can read.

Example:
productIds
string[]

Products linked to this group. A MEMBER, READER or HUMAN_EVALUATOR caller sees only the linked products it can read.

Example:
allProducts
boolean

Grants this group every product of its organization, current and future. Wins over explicit product links while set.

Example:

false

permissions
string[] | null

The product permissions the group grants on its products, each written entity.action, sorted. Null means no custom list: the group grants every permission its members role allows. An empty list grants nothing. A user in several groups may do an action when any group that reaches the product lists it, and the role of the user still limits what a list can grant.

Example:
deletedAt
string<date-time> | null