Skip to content

Function: unlinkScimUser() ​

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

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

Unlinks a SCIM user from their Atlassian account without deleting the user.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ orgId: string; scimDirectoryId: string; scimUserId: string; }-
parameters.orgIdstringYour organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
parameters.scimDirectoryId?stringThe SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.scimUserId?stringThe SCIM user ID to unlink. Use the Get SCIM Links for an email API to get the SCIM User ID.
options?RequestOptions-

Returns ​

Promise<void>