Internal Users

Suspend many internal users

POST/internal-users/bulk/suspend
internal-users:writebulk_suspend_internal_usersIdempotent

Suspends up to 100 internal users, or 101 to 10,000 as a job that answers 202. Each item is {id} with its own notify and remove_distribution and runs as POST /internal-users/{id}/actions/suspend does; a failed item, such as a deactivated user or the token's own user (409 invalid_state) or a SCIM-managed one (409 scim_managed), is reported in its slot and sends no email. dry_run runs up to 100 items and rolls them back. Emits internal_user.suspended per user changed. POST /internal-users/bulk/activate undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · InternalUserBulkSuspend

  • itemsobject[]Required#

    Up to 10,000 items. Up to 100 run in the request.

{
  "items": [
    {
      "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
      "notify": "email"
    },
    {
      "id": "9f8e7d6c-5b4a-4039-8271-6e5d4c3b2a19",
      "remove_distribution": true
    }
  ]
}

Responses

200

Every item in request order, each succeeded or failed.

InternalUserBulkReport
{
  "data": [
    {
      "index": 1,
      "status": "succeeded",
      "data": {},
      "error": {}
    }
  ],
  "meta": {
    "succeeded": 1,
    "failed": 1
  }
}
202

More than 100 items. A job runs them; its report has the same shape as the 200 body.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/internal-users/bulk/suspend\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    {
      "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
      "notify": "email"
    },
    {
      "id": "9f8e7d6c-5b4a-4039-8271-6e5d4c3b2a19",
      "remove_distribution": true
    }
  ]
}'