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

Function: deleteUser()

deleteUser(client, userId): Promise<void>

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

Disables a user (soft delete - sets userState to DELETED). Users must be disabled before they can be purged.

Parameters

client

AccountManagerUsersClient

Account Manager Users client

userId

string

User ID

Returns

Promise<void>

Throws

Error if request fails