Update group configuration

Updates the configuration and metadata of an existing group, including description and other group-level properties.

PATCH/organizations/{organizationName}/groups/{groupName}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

groupName*string

The unique identifier of the group

Match^(?!.*\*)(?!.*[/]).{1,70}$

Request Body

application/json

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

organizationName?IdentifierPattern

The name of the organization that owns this group

Match^[a-zA-Z0-9_ -]+$

groupName?GroupNamePattern

The unique identifier for the group within the organization

Match^(?!.*\*)(?!.*[/]).{1,70}$

description?string

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

createdAt?string

ISO 8601 timestamp indicating when the group was created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when the group was last modified

Formatdate-time

Response Body

`application/json`

curl --request PATCH \  --url 'https://example.com/organizations/string/groups/string' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "organizationName": "string",  "groupName": "string",  "description": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update group configuration

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`