Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Roles

Update organization role

client.admin.organization.roles.update(stringroleID, RoleUpdateParams { description, permissions, role_name } body, RequestOptionsoptions?): Role { id, description, name, 4 more }
POST/organization/roles/{role_id}

Updates an existing organization role.

ParametersExpand Collapse
roleID: string
body: RoleUpdateParams { description, permissions, role_name }
description?: string | null

New description for the role.

permissions?: Array<string> | null

Updated set of permissions for the role.

role_name?: string | null

New name for the role.

ReturnsExpand Collapse
Role { 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 | null

Optional description of the role.

name: string

Unique name for the role.

object: "role"

Always role.

permissions: Array<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

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const role = await client.admin.organization.roles.update('role_id');

console.log(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
}