Function: removeDirectoryUser()

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

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

Remove a user from a directory if you don’t want them to appear in your directory or have access to your apps anymore. You’re not billed for a user once they’re removed. You must invite the user to your organization again if you want to reinstate their access to your apps. You’ll need to assign their roles and group memberships again.

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>