Built LMS Help Center
MCP ServerTool Reference

Revoke Certificate

Revoke Certificate MCP tool.

Revoke Certificate

Revoke one issued certificate with a reason; returns it with status revoked. Revoking again is a no-op that keeps the original revoked_at and reason.

Contract

FieldValue
Tool namerevoke_certificate
Domaincertifications
Required scopescourses:manage
TitleRevoke certificate
Read only hintfalse
Destructive hinttrue
Idempotent hinttrue
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keycertificate_issuances.revoke
REST siblingPUT /api/public/v1/certificate-issuances/{id}/revoke

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "revocation_reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9._:-]+$"
    }
  },
  "required": [
    "id",
    "revocation_reason",
    "idempotency_key"
  ],
  "additionalProperties": false
}

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false
}

On this page