Function: deleteProvisioningRecord()

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

Defined in: src/userProvisioning/api/scimLinks.ts:74

Delete a user in our SCIM DB with a Atlassian Account ID (AAID). This will apply to all directories in your organization matching that AAID and only works for managed users.

You will have to completely reprovision the user to their respective groups after deletion.

Explore more about updating managed SCIM email addresses.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ aaId: string; orgId: string; }	-
parameters.aaId	string	Unique ID of the user's account. The AAID can either be found in the URL of a user's profile, when browsing in the "Users" tab or the "Managed Users" tab or use the Get Users API to get the AAID. The URL could look like: https://admin.atlassian.com/o/{orgId}/users/{aaId} https://admin.atlassian.com/o/{orgId}/members/{aaId} https://admin.atlassian.com/s/{siteId}/users/{aaId}
parameters.orgId?	string	Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
options?	RequestOptions	-

Returns

Promise<void>