Skip to navigation

Suspend User(s)

View as Markdown

Suspends one or more users by user ID or username. Both useridst and usernames accept comma-separated values. Organization ID is required for tenant users.

Notes

  • You may suspend users by providing either useridst, usernames, or both, as comma-separated values.

  • orgid is required for tenant users; omit or set to null for non-tenant users if your backend allows.

  • Ensure the auth token is valid and has the necessary permissions.

Request

This endpoint expects an object.
authstringRequired
useridststringRequired
comma separated userids
usernamesstringRequired
comma separated usernames

Response headers

Keep-AlivestringOptional
X-Powered-BystringOptional

Response

OK
messagestring
successboolean