Function: removeUser()

function removeUser(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/users.ts:119

Removes user and its references (like project roles associations, watches, history). Note: user references will not be removed if multiple User Directories are used and there is a user with the same name existing in another directory (shadowing user).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ key?: string; username?: string; }	-
parameters.key?	string	User key
parameters.username?	string	The username
options?	RequestOptions	-

Returns

Promise<void>