Skip to main content
PATCH
/
v1
/
regions
/
global
/
iam
/
groups
/
{id}
Update group
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: '<string>', description: '<string>'})
};

fetch('https://api.k0rdent.ai/v1/regions/global/iam/groups/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "group-d5e6f7",
  "displayName": "Platform Engineers",
  "createdAt": "2023-11-07T05:31:56Z",
  "selfLink": "/v1/regions/global/iam/groups/group-d5e6f7",
  "description": "<string>",
  "memberCount": 12,
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

​
id
string
required

Unique group identifier

Body

application/json
​
displayName
string

Updated display name

​
description
string

Updated group description

Response

Group successfully updated

User group for team-based access control.

​
uid
string<uuid>
required

Server-generated UUID.

​
id
string
required

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"group-d5e6f7"

​
displayName
string
required

Human-readable display name for the group.

Required string length: 1 - 255
Example:

"Platform Engineers"

​
createdAt
string<date-time>
required

Group creation timestamp

​
selfLink
string<uri>

Server-defined URL for this resource.

Example:

"/v1/regions/global/iam/groups/group-d5e6f7"

​
description
string

Human-readable group description

​
memberCount
integer

Number of members in the group.

Example:

12

​
updatedAt
string<date-time>

Group last update timestamp