Skip to content
Primary navigation

Delete user

client.admin.organization.users.delete(stringuserID, RequestOptionsoptions?): UserDeleteResponse { id, deleted, object }
DELETE/organization/users/{user_id}

Deletes a user from the organization.

ParametersExpand Collapse
userID: string
ReturnsExpand Collapse
UserDeleteResponse { id, deleted, object }
id: string
deleted: boolean
object: "organization.user.deleted"

Delete user

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const user = await client.admin.organization.users.delete('user_id');

console.log(user.id);
{
    "object": "organization.user.deleted",
    "id": "user_abc",
    "deleted": true
}
Returns Examples
{
    "object": "organization.user.deleted",
    "id": "user_abc",
    "deleted": true
}