Skip to content
Primary navigation

Update group

$ openai admin:organization:groups update
POST/organization/groups/{group_id}

Updates a group’s information.

ParametersExpand Collapse
--group-id: string

The ID of the group to update.

--name: string

New display name for the group.

ReturnsExpand Collapse
AdminOrganizationGroupUpdateResponse: object { id, created_at, is_scim_managed, name }

Response returned after updating a group.

id: string

Identifier for the group.

created_at: number

Unix timestamp (in seconds) when the group was created.

is_scim_managed: boolean

Whether the group is managed through SCIM and controlled by your identity provider.

name: string

Updated display name for the group.

Update group

openai admin:organization:groups update \
  --admin-api-key 'My Admin API Key' \
  --group-id group_id \
  --name x
{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Escalations",
    "created_at": 1711471533,
    "is_scim_managed": false
}
Returns Examples
{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Escalations",
    "created_at": 1711471533,
    "is_scim_managed": false
}