Skip to content
Primary navigation

Delete organization role

admin.organization.roles.delete(strrole_id) -> RoleDeleteResponse
DELETE/organization/roles/{role_id}

Deletes a custom role from the organization.

ParametersExpand Collapse
role_id: str
ReturnsExpand Collapse
class RoleDeleteResponse:

Confirmation payload returned after deleting a role.

id: str

Identifier of the deleted role.

deleted: bool

Whether the role was deleted.

object: Literal["role.deleted"]

Always role.deleted.

Delete organization role

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
role = client.admin.organization.roles.delete(
    "role_id",
)
print(role.id)
{
    "object": "role.deleted",
    "id": "role_01J1F8ROLE01",
    "deleted": true
}
Returns Examples
{
    "object": "role.deleted",
    "id": "role_01J1F8ROLE01",
    "deleted": true
}