TracePass
Zugangsberechtigungen

Zugangsberechtigung widerrufen

Eine Berechtigung widerrufen: Ihr Token funktioniert sofort nicht mehr. Idempotent: Das Widerrufen einer bereits widerrufenen Berechtigung ergibt erneut 200 mit ihr. Nur eine ID, die nicht Ihrem Unternehmen gehört, ergibt 404. Eine Behörden-Berechtigung (Behörden-Rolle oder Stufe authority) lässt sich nur im Dashboard widerrufen: über die API ergibt sie 400 role_dashboard_only.

DELETE/api/v1/access-grants/{id}
OpenAPI 3.1 herunterladen
DELETE/api/v1/access-grants/{id}

Zugangsberechtigung widerrufen

Eine Berechtigung widerrufen: Ihr Token funktioniert sofort nicht mehr. Idempotent: Das Widerrufen einer bereits widerrufenen Berechtigung ergibt erneut 200 mit ihr. Nur eine ID, die nicht Ihrem Unternehmen gehört, ergibt 404. Eine Behörden-Berechtigung (Behörden-Rolle oder Stufe authority) lässt sich nur im Dashboard widerrufen: über die API ergibt sie 400 role_dashboard_only.

Der Widerruf wird nicht durch ein überfälliges Abo blockiert, ein Unternehmen kann den Zugriff also immer beenden. Er zählt als ein v1-Schreibvorgang, wenn er widerruft. Der Widerruf wird mit dem API-Schlüssel oder der App, die ihn vorgenommen hat, im Zugriffsprotokoll festgehalten. Unterstützt Idempotency-Key.

Wer darf aufrufen. Ein API-Schlüssel nur, wenn sein Eigentümer „May manage access grants“ für diesen Schlüssel auf der Developer-Seite eingeschaltet hat (standardmäßig aus; sonst 403 access_grants_not_enabled). Ein OAuth-Token braucht den Scope access_grants:write und einen Admin- oder Owner-Nutzer.

Pfad-Parameter

  • iderforderlich

    string (24 hex chars)

    ID der Zugangsberechtigung.

Header

  • Authorizationerforderlich

    string

    Bearer <token> — entweder ein tp_ API-Schlüssel (Developer → API Keys; am einfachsten, für Server-zu-Server) oder ein OAuth-2.0-Access-Token (Developer → OAuth Apps; für nutzerautorisierte Apps, scoped und widerrufbar). Die Authentication-Seite enthält den vollständigen OAuth-Flow und die Scope-Liste.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4.

Anfrage

curl -sS -X DELETE https://app.tracepass.eu/api/v1/access-grants/6650c1d2e3f4a5b6c7d8e9f0 \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx"

Antwort

{
  "data": {
    "id": "6650c1d2e3f4a5b6c7d8e9f0",
    "accessLevel": "restricted",
    "label": "Buyer GmbH, order 4711",
    "role": "purchaser",
    "scope": { "kind": "passports", "ids": ["6650a1b2c3d4e5f6a7b8c9d0"] },
    "purpose": null,
    "evidence": null,
    "state": "revoked",
    "expiresAt": null,
    "useCount": 0,
    "createdAt": "2026-06-01T09:30:00.000Z"
  }
}