Ban Clerk user

Ban a user from signing in to a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/users/{user_id}/ban

https://api.vee3.io/v1/clerk/users/{user_id}/ban

5 tokens

Ban a user from signing in to a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.ban_user

Parameters2 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

user_idstringRequired

Clerk user id (user_...) to ban.

Response6 fields

userobject

5 fields

Updated Clerk user object after the ban.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/users/{user_id}/ban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after being banned.

banned_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}