Skip to content
Omniglass Omniglass Omniglass

Update a principal group

PATCH
/principal-groups/{id}
 
curl --request PATCH \
  --url https://example.com/api/v1/principal-groups/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "display_name": "example", "name": "example" }'

Updates a group’s name and presentational fields. Gated by principal_group:update (all-scope). A duplicate name is 409.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required

The group’s id (uuid)

string

The group’s id (uuid)

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
description

Description; empty clears it

string
<= 1000 characters
display_name

Display name; empty clears it

string
<= 200 characters
name

Group name (lowercase letters, digits, and . _ -); renaming is safe

string
>= 1 characters <= 200 characters /^[a-z0-9][a-z0-9._-]*$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
description
string
display_name
string
grant_count
required

How many grants the group confers on its members.

integer format: int64
id
required
string
member_count
required

How many principals belong to the group (populated on list and get; 0 from create/update).

integer format: int64
name
required
string
Example 
{
  "$schema": "/api/v1/schemas/GroupBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}