Skip to content
SHAMPOO

Tool catalogue

revoke_ticket

Write · Conductor only · Authentication

revoke_ticket

  • Category: auth
  • Access: write
  • Audience: administrative (ordinary users do not normally call this directly)

Purpose

Cancels an unused enrolment ticket. Call it when a ticket was issued in error or is no longer needed.

Arguments

Required: ticket_id.

Optional: reason.

  • ticket_id.
  • reason.

Result

Object with revoked (echoed ticket_id) and matched (1 cancelled, 0 untouched).

Boundaries

Conductor role required. Only unused tickets flip; used, expired, or revoked tickets report matched 0.

Lifecycle / side effects

Moves one unused ticket entry to revoked with a reason. The grant never activates.

Errors

Non-conductor callers get a requires-conductor error payload. Missing ticket_id is a tool error.

Example

{
  "reason": "sent to wrong channel",
  "ticket_id": "<uuid>"
}

Result shape:

{
  "matched": 1,
  "revoked": "<uuid>"
}

See also

issue_enrollment_ticket, revoke_agent, handshake_challenge, list_sessions.

On this page