DeleteUser

client.users.deleteUser(, ?): UserDeleteUserResponse

POST/gitpod.v1.UserService/DeleteUser

Deletes a user. If the User comes from an organization’s SSO provider, the Account will also be deleted.

ParametersExpand Collapse

body: UserDeleteUserParams { userId }

userId?: string

formatuuid

ReturnsExpand Collapse

UserDeleteUserResponse = unknown

DeleteUser

import Gitpod from '@gitpod/sdk';

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

const response = await client.users.deleteUser();

console.log(response);

{}

Returns Examples

{}