`banUser()`

Marks the given User as banned, which means that all their sessions are revoked and they are not allowed to sign in again.


function banUser: (userId: string) => Promise<User>;

`banUser()` parameters

Name	Type	Description
`userId`	`string`	The ID of the user to ban.

`banUser()` example


const userId = 'user_2V7JJKmoA9HqzHhfMqK5cpgLl56';
 
const response = await clerkClient.users.banUser(userId);
 
console.log(response);
/*
_User {
  id: 'user_2V7JJKmoA9HqzHhfMqK5cpgLl56',
  passwordEnabled: false,
  totpEnabled: false,
  backupCodeEnabled: false,
  twoFactorEnabled: false,
  banned: true,
  createdAt: 1694181111181,
  updatedAt: 1708101775581,
  imageUrl: 'https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvb2F1dGhfZ29vZ2xlL2ltZ18yVjdKSkhvdXlnbDNLRXRaUjlRRlFNbnVDU2cuanBlZyJ9',
  hasImage: true,
  primaryEmailAddressId: 'idn_2V7JJ2R3O7KWHjCmUuEOJESHlPz',
  primaryPhoneNumberId: null,
  primaryWeb3WalletId: null,
  lastSignInAt: 1708101739595,
  externalId: null,
  username: null,
  firstName: 'Alexis',
  lastName: 'Aguilar',
  publicMetadata: {},
  privateMetadata: {},
  unsafeMetadata: {},
  emailAddresses: [
    _EmailAddress {
      id: 'idn_2V7JJ2R3O7KWHjCmUuEOJESHlPz',
      emailAddress: 'alexis@clerk.dev',
      verification: [_Verification],
      linkedTo: [Array]
    }
  ],
  phoneNumbers: [],
  web3Wallets: [],
  externalAccounts: [
    _ExternalAccount {
      id: 'idn_2V7JJ4xpXyj0mazg3lsLYOUit9t',
      provider: undefined,
      identificationId: undefined,
      externalId: undefined,
      approvedScopes: 'email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile',
      emailAddress: 'alexis@clerk.dev',
      firstName: undefined,
      lastName: undefined,
      imageUrl: undefined,
      username: null,
      publicMetadata: {},
      label: null,
      verification: [_Verification]
    }
  ],
  lastActiveAt: 1708041600000,
  createOrganizationEnabled: true
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/users/{user_id}/ban. See the BAPI reference(opens in a new tab) for more details.

banUser() parameters

banUser() example

Backend API (BAPI) endpoint

`banUser()` parameters

`banUser()` example