Files
developer.sailpoint.com/docs/connectivity/saas-connectivity/connector-commands/account-delete.md
2024-07-01 12:56:17 -05:00

2.2 KiB

id, title, pagination_label, sidebar_label, keywords, description, slug, tags
id title pagination_label sidebar_label keywords description slug tags
account-delete Account Delete Account Delete Account Delete
connectivity
connectors
account delete
Remove account from a source. /connectivity/saas-connectivity/commands/account-delete
Connectivity
Connector Command
Input/Output Data Type
Input StdAccountDeleteInput
Output StdAccountDeleteOutput

Example StdAccountDeleteInput

{
    "identity": "john.doe",
    "key": {
        "simple": {
            "id": "john.doe"
        }
    }
}

Example StdAccountDeleteOutput

{
}

Description

The account delete command sends one attribute from ISC, the identity to delete. This can be passed to your connector to delete the account from the source system.

Enable account delete in ISC through a BeforeProvisioning rule. The connector honors whichever operation the provisioning plan sends. For more information, see the [documentation](https://community.sailpoint.com/t5/Identity Security Cloud-Articles/Identity Security Cloud-Rule-Guide/ta-p/76665) and an [example implementation](https://community.sailpoint.com/t5/Identity Security Cloud-Wiki/Identity Security Cloud-Rule-Guide-Before-Provisioning-Rule/ta-p/77415).

To use this command, you must specify this value in the commands array: std:account:delete

The following snippet shows an example of account delete command implementation:

index.ts

.stdAccountDelete(async (context: Context, input: StdAccountDeleteInput, res: Response<StdAccountDeleteOutput>) => {
    const account = await airtable.getAccount(input.key)
    res.send(await airtable.deleteAccount(account.airtableId))
})

airtable.ts

async deleteAccount(airTableid: string): Promise<Record<string, never>> {
    return this.airTableBase('Users').destroy(airTableid,
    ).then(() => {
        return {}
    }).catch(err => {
        throw new ConnectorError('error while deleting account: ' + err)
    })
}