Function: removeUser()

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

Defined in: src/cloud/api/users.ts:84

Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

Permissions required: Site administration (that is, membership of the site-admin group).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; }	-
parameters.accountId	string	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?	RequestOptions	-

Returns

Promise<void>