Sign in
Auth Admin

Ban a user

Changed on

Bans a user temporarily or permanently. Banned users cannot sign in and all their active sessions are immediately revoked. Omitting banned_until clears any previous expiry. Deleted accounts cannot be banned.

  • Omit banned_until for a permanent ban
  • Provide banned_until ISO timestamp for a temporary ban
post/projects/{id}/auth/users/{userId}/ban

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/auth/users/{userId}/ban
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

userIdstring uuid required

Request body

banned_untilstring date-time

When the ban expires (omit for permanent ban)

Example request

{
  "banned_until": "2026-12-31T23:59:59Z"
}

Response

User banned successfully

messagestring required
user_idstring uuid required
emailstring email required
status'banned' required
banned_untilstring date-time nullable

When the ban expires (null for permanent ban)

Example response

{
  "message": "User banned until 2026-12-31T23:59:59Z"
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the non-success response with the status

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status