Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Roles

Update organization role

$ openai admin:organization:roles update
POST/organization/roles/{role_id}

Updates an existing organization role.

ParametersExpand Collapse
--role-id: string

The ID of the role to update.

--description: optional string

New description for the role.

--permission: optional array of string

Updated set of permissions for the role.

--role-name: optional string

New name for the role.

ReturnsExpand Collapse
role: object { id, description, name, 4 more }

Details about a role that can be assigned through the public Roles API.

id: string

Identifier for the role.

description: string

Optional description of the role.

name: string

Unique name for the role.

object: "role"

Always role.

permissions: array of string

Permissions granted by the role.

predefined_role: boolean

Whether the role is predefined and managed by OpenAI.

resource_type: string

Resource type the role is bound to (for example api.organization or api.project).

Update organization role

openai admin:organization:roles update \
  --admin-api-key 'My Admin API Key' \
  --role-id role_id
{
    "object": "role",
    "id": "role_01J1F8ROLE01",
    "name": "API Group Manager",
    "description": "Allows managing organization groups",
    "permissions": [
        "api.groups.read",
        "api.groups.write"
    ],
    "resource_type": "api.organization",
    "predefined_role": false
}
Returns Examples
{
    "object": "role",
    "id": "role_01J1F8ROLE01",
    "name": "API Group Manager",
    "description": "Allows managing organization groups",
    "permissions": [
        "api.groups.read",
        "api.groups.write"
    ],
    "resource_type": "api.organization",
    "predefined_role": false
}