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
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { orgId: string; scimDirectoryId: string; scimUserId: string; } | - |
parameters.orgId | string | Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously. |
parameters.scimDirectoryId? | string | The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning. |
parameters.scimUserId? | string | The 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>