Skip to content

Users

users_users_erase

GDPR hard erasure (Art.

Tool

users_users_erase

GDPR hard erasure (Art.

GDPR hard erasure (Art. 17) of one end user. IRREVERSIBLE and quite different from users_users_delete: the identifier and identity rows are DELETED, the profile fields nulled and all three metadata bags emptied. What survives is a tombstone — the user row with its id and `erasedAt` — so that every foreign reference and webhook consumer holding that id still resolves. The audit trail is KEPT but pseudonymized (the metadata of rows targeting this user is cleared), because a security log that erasure can rewrite is not a security log. The email is freed: registering it again creates a NEW user id. Emits `users/user.erased` so consumers purge their own copies. Idempotent — erasing an already-erased user returns the same tombstone and changes nothing.

Behavior

HTTP
POST /users/users/:userId/erase

Arguments

NameTypeRequiredDescription
userIdstringThe opaque user id returned by users_users_create or _list.

Response

FieldTypeAlwaysDescription
idstring
namestring
bannedAtstring
erasedAtstring
imageUrlstring
testUserboolean
createdAtstring
deletedAtstring
productIdstring
updatedAtstring
waitlistedboolean
identifiersarray
lockedUntilstring
lastSignInAtstring
requiresResetboolean
publicMetadataobject
unsafeMetadataobject
privateMetadataobject
emailChangeLockedUntilstring

Try it

GDPR hard erasure (Art.

When to use

GDPR hard erasure (Art. 17) of one end user. IRREVERSIBLE and quite different from users_users_delete: the identifier and identity rows are DELETED, the profile fields nulled and all three metadata bags emptied. What survives is a tombstone — the user row with its id and `erasedAt` — so that every foreign reference and webhook consumer holding that id still resolves. The audit trail is KEPT but pseudonymized (the metadata of rows targeting this user is cleared), because a security log that erasure can rewrite is not a security log. The email is freed: registering it again creates a NEW user id. Emits `users/user.erased` so consumers purge their own copies. Idempotent — erasing an already-erased user returns the same tombstone and changes nothing.

Example

Ask your agent something like this:

GDPR hard erasure (Art.

The agent will invoke users_users_erase with these arguments:

{
  "userId": "<userId>"
}

Esc

Start typing to search the docs.

navigateselect