@salesforce/b2c-tooling-sdk / clients / purgeUser

Function: purgeUser()

purgeUser(client, userId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/clients/am-api.ts:367

Purges a user (hard delete). Users must be in DELETED state before they can be purged.

Parameters

client

AccountManagerUsersClient

Account Manager Users client

userId

string

User ID

Returns

Promise<void>

Throws

Error if request fails