Skip to content
Primary navigation

Delete project role

admin.organization.projects.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse
DELETE/projects/{project_id}/roles/{role_id}

Deletes a custom role from a project.

ParametersExpand Collapse
project_id: str
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 project 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.projects.roles.delete(
    role_id="role_id",
    project_id="project_id",
)
print(role.id)
{
    "object": "role.deleted",
    "id": "role_01J1F8PROJ",
    "deleted": true
}
Returns Examples
{
    "object": "role.deleted",
    "id": "role_01J1F8PROJ",
    "deleted": true
}