Skip to content
OriginChats

user_kick

user_kick is implemented by handleUserKick in src/api/handlers/user/user_kick.osl.

Handles the user kick 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: "user_kick" and may include an opaque listener correlation value.

Field Validation / meaning
user schema.string().trim().minLen(1)
reason schema.string().defaultValue("No reason provided")

Validator source

Section titled “Validator source”

The handler and shared validation path use these OSL schema definitions before normalization:

*schema.Schema schemaUserKick = schema.object({
  user: schema.string().trim().minLen(1),
  reason: schema.string().defaultValue("No reason provided")
})

Processing path

Section titled “Processing path”
  1. handleCmd enforces authentication and the manage_users permission.
  2. dispatchCmd routes user_kick to handleUserKick.
  3. The adapter validates and normalizes input, then calls its domain collaborators.
  4. Durable mutations complete before the response or event is returned.
  5. onMessage adds the request listener to direct responses and performs any marked broadcast.

Direct collaborators visible in the handler: userFromUsername, userFromId, userHasPermission, disconnectUser, auditRecord, broadcastAuthed

Responses and events

Section titled “Responses and events”

Response/event command names visible in this adapter: auth_error, user_kick.

Validation and domain failures use:

{
  "cmd": "error",
  "val": "<message>",
  "src": "user_kick",
  "listener": "<copied from request>"
}