Skip to main content

DeleteUserResponse

Package: @nauth-toolkit/client Type: Response

Response payload for user deletion. Returns deletion confirmation with cascade cleanup information showing how many related records were deleted.

import { DeleteUserResponse } from '@nauth-toolkit/client';

Properties

PropertyTypeDescription
deletedRecordsobjectNumber of related records deleted
deletedRecords.auditLogsnumberNumber of audit logs deleted
deletedRecords.challengeSessionsnumberNumber of challenge sessions deleted
deletedRecords.loginAttemptsnumberNumber of login attempts deleted
deletedRecords.mfaDevicesnumberNumber of MFA devices deleted
deletedRecords.sessionsnumberNumber of sessions deleted
deletedRecords.socialAccountsnumberNumber of social accounts deleted
deletedRecords.trustedDevicesnumberNumber of trusted devices deleted
deletedRecords.verificationTokensnumberNumber of verification tokens deleted
deletedUserIdstringDeleted user ID (sub)
successbooleanSuccess indicator

Example

{
"success": true,
"deletedUserId": "a21b654c-2746-4168-acee-c175083a65cd",
"deletedRecords": {
"sessions": 5,
"verificationTokens": 2,
"mfaDevices": 1,
"trustedDevices": 3,
"socialAccounts": 1,
"loginAttempts": 42,
"challengeSessions": 8,
"auditLogs": 150
}
}

Used By