Skip to content
Primary navigation

Unassign organization role from group

client.admin.organization.groups.roles.delete(stringroleID, RoleDeleteParams { group_id } params, RequestOptionsoptions?): RoleDeleteResponse { deleted, object }
DELETE/organization/groups/{group_id}/roles/{role_id}

Unassigns an organization role from a group within the organization.

ParametersExpand Collapse
roleID: string
params: RoleDeleteParams { group_id }
group_id: string

The ID of the group to modify.

ReturnsExpand Collapse
RoleDeleteResponse { deleted, object }

Confirmation payload returned after unassigning a role.

deleted: boolean

Whether the assignment was removed.

object: string

Identifier for the deleted assignment, such as group.role.deleted or user.role.deleted.

Unassign organization role from group

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.groups.roles.delete('role_id', {
  group_id: 'group_id',
});

console.log(role.deleted);
{
    "object": "group.role.deleted",
    "deleted": true
}
Returns Examples
{
    "object": "group.role.deleted",
    "deleted": true
}