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

Body

application/json
name
string
required
Example:

"Example Name"

organizationId
string | null

Defaults to the caller's organization.

Example:

"org_123"

type
string | null

Defaults to EVALUATOR.

Example:

"EVALUATOR"

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

permissionPreset
enum<string> | null

The preset the group follows; when the preset changes, the group's permissions change with it. Null means the group holds its own list in permissions. Send a preset id with no permissions list, or null with one. With neither field, the group follows EDITOR.

Available options:
EDITOR,
HUMAN_EVALUATOR,
READER,
null
Example:

"READER"

permissions
any | null

The permissions the group grants, each written entity.action, sorted. A product entry applies to the products the group reaches; a metric, model or comment entry applies across the organization. For a group that follows a preset, this is the preset's current list. Null means the group follows the EDITOR preset: it grants every permission its members role allows. An empty list grants nothing. A user in several groups may do a product action when any group that reaches the product lists it, and an organization action when any group lists it. The role of the user still limits what a list can grant. Takes the same list as PATCH /userGroups/{id}. A list makes the group hold its own and cannot go with a permissionPreset id. Omit the field or send null to follow EDITOR.

Example:
productIds
string[]

Products of the organization to link to the new group, in the same transaction as the group. Omit the field or send an empty array to link none.

Example:

Response

User group created successfully. On Prefer: return=minimal, or when the read after the write fails, the answer has no body.

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 MEMBER caller sees only the linked metrics it can read.

Example:
productIds
string[]

Products linked to this group. A MEMBER 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

permissionPreset
enum<string> | null

The preset the group follows; when the preset changes, the group's permissions change with it. Null means the group holds its own list in permissions.

Available options:
EDITOR,
HUMAN_EVALUATOR,
READER,
null
Example:

"READER"

permissions
string[] | null

The permissions the group grants, each written entity.action, sorted. A product entry applies to the products the group reaches; a metric, model or comment entry applies across the organization. For a group that follows a preset, this is the preset's current list. Null means the group follows the EDITOR preset: it grants every permission its members role allows. An empty list grants nothing. A user in several groups may do a product action when any group that reaches the product lists it, and an organization action when any group lists it. The role of the user still limits what a list can grant.

Example:
deletedAt
string<date-time> | null