Users

users_users_ban

Ban an end user by stamping `bannedAt`.

Tool

users_users_ban

Ban an end user by stamping `bannedAt`.

Ban an end user by stamping `bannedAt`. NOTE: sessions do not exist yet — until Phase 2 lands auth flows, this is a flag on the record and nothing is revoked or refused by it. Idempotent: banning an already-banned user refreshes the stamp.

Behavior

HTTP: POST /users/users/:userId/ban

Arguments

Name	Type	Required	Description
userId	string	•	The opaque user id returned by users_users_create or _list.

Response

Field	Type	Always
id	string	•
name	string	•
bannedAt	string	•
erasedAt	string	•
imageUrl	string	•
testUser	boolean	•
createdAt	string	•
deletedAt	string	•
productId	string	•
updatedAt	string	•
waitlisted	boolean	•
identifiers	array	•
lockedUntil	string	•
lastSignInAt	string	•
requiresReset	boolean	•
publicMetadata	object	•
unsafeMetadata	object	•
privateMetadata	object	•
emailChangeLockedUntil	string	•

Try it

Ban an end user by stamping `bannedAt`.

When to use

Example

Ask your agent something like this:

Ban an end user by stamping `bannedAt`.

The agent will invoke users_users_ban with these arguments:

{
  "userId": "<userId>"
}