Skip to main content
PATCH
/
organizations
/
{organizationName}
/
groups
/
{groupName}
Error
A valid request URL is required to generate request examples
{
  "organizationName": "<string>",
  "groupName": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

groupName
string
required

The unique identifier of the group Standard identifier pattern for resource names

Body

application/json

Represents a user group for organizing users and managing group-based permissions

organizationName
string

The name of the organization that owns this group

groupName
string

The unique identifier for the group within the organization

description
string

Human-readable description of the group's purpose and membership

createdAt
string<date-time>

ISO 8601 timestamp indicating when the group was created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the group was last modified

Response

Group updated successfully

Represents a user group for organizing users and managing group-based permissions

organizationName
string

The name of the organization that owns this group

groupName
string

The unique identifier for the group within the organization

description
string

Human-readable description of the group's purpose and membership

createdAt
string<date-time>

ISO 8601 timestamp indicating when the group was created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the group was last modified