users_banned
users_banned is implemented by handleUsersBanned in src/api/handlers/user/users_banned.osl.
Handles the users banned protocol operation through the resource-specific helper and storage layers.
Access
Section titled “Access”| Gate | Requirement |
|---|---|
| Authentication | Required by the central API gate. |
| Central permission | manage_users |
| Broadcast | Not marked global directly by this adapter. A helper may emit focused or server-wide updates. |
Request
Section titled “Request”Every request includes cmd: "users_banned" and may include an opaque listener correlation value.
| Field | Validation / meaning |
|---|---|
| — | No command-specific request fields. |
Validator source
Section titled “Validator source”This adapter delegates validation to a shared helper. The field table lists values read directly by the handler; follow the collaborators below for the shared domain schema.
Processing path
Section titled “Processing path”handleCmdenforces authentication and themanage_userspermission.dispatchCmdroutesusers_bannedtohandleUsersBanned.- The adapter validates and normalizes input, then calls its domain collaborators.
- Durable mutations complete before the response or event is returned.
onMessageadds the request listener to direct responses and performs any marked broadcast.
Direct collaborators visible in the handler: usersBanned
Responses and events
Section titled “Responses and events”Response/event command names visible in this adapter: users_banned.
Validation and domain failures use:
{ "cmd": "error", "val": "<message>", "src": "users_banned", "listener": "<copied from request>"}