Function: deactivateUser()

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

Defined in: src/userManagement/api/lifecycle.ts:12

Deactivate (block) the specified user account from logging into Atlassian. The permission to make use of this resource is exposed by the lifecycle.enablement privilege. You can optionally set a message associated with the block. If none is supplied, a default message will be used.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; message?: string; }	-
parameters.accountId	string	The ID of the user
parameters.message?	string	-
options?	RequestOptions	-

Returns

Promise<void>