Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Roles

List organization roles

$ openai admin:organization:roles list
GET/organization/roles

Lists the roles configured for the organization.

ParametersExpand Collapse
--after: optional string

Cursor for pagination. Provide the value from the previous response’s next field to continue listing roles.

--limit: optional number

A limit on the number of roles to return. Defaults to 1000.

--order: optional "asc" or "desc"

Sort order for the returned roles.

ReturnsExpand Collapse
PublicRoleListResource: object { data, has_more, next, object }

Paginated list of roles available on an organization or project.

data: array of Role { id, description, name, 4 more }

Roles returned in the current page.

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

has_more: boolean

Whether more roles are available when paginating.

object: "list"

Always list.

List organization roles

openai admin:organization:roles list \
  --admin-api-key 'My Admin API Key'
{
    "object": "list",
    "data": [
        {
            "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
        }
    ],
    "has_more": false,
    "next": null
}
Returns Examples
{
    "object": "list",
    "data": [
        {
            "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
        }
    ],
    "has_more": false,
    "next": null
}