API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Roles

List organization roles

$ openai admin:organization:roles list

GET/organization/roles

Create organization role

$ openai admin:organization:roles create

POST/organization/roles

Retrieve organization role

$ openai admin:organization:roles retrieve

GET/organization/roles/{role_id}

Update organization role

$ openai admin:organization:roles update

POST/organization/roles/{role_id}

Delete organization role

$ openai admin:organization:roles delete

DELETE/organization/roles/{role_id}

ModelsExpand 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).