Function: suspendDirectoryUser()

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

Defined in: src/admin/api/users.ts:208

Suspend a user’s access in a directory to remove their access to apps temporarily. You’re not billed for a user when their access is suspended. They regain their roles and group memberships when you restore their access.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; directoryId: string; orgId: string; }	-
parameters.accountId	string	Every user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?	string	A directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

Promise<void>