TracePass
Zugangsberechtigungen

Zugangsberechtigung ändern

Label, Zweck, Nachweis, Ablauf oder Umfang einer aktiven Berechtigung ändern. Senden Sie nur die Schlüssel, die sich ändern sollen, mindestens einen. Die Rolle lässt sich nicht ändern: Widerrufen Sie die Berechtigung und erstellen Sie eine neue. Eine Behörden-Berechtigung (Behörden-Rolle oder Stufe authority) lässt sich nur im Dashboard ändern: über die API ergibt sie 400 role_dashboard_only.

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

Zugangsberechtigung ändern

Label, Zweck, Nachweis, Ablauf oder Umfang einer aktiven Berechtigung ändern. Senden Sie nur die Schlüssel, die sich ändern sollen, mindestens einen. Die Rolle lässt sich nicht ändern: Widerrufen Sie die Berechtigung und erstellen Sie eine neue. Eine Behörden-Berechtigung (Behörden-Rolle oder Stufe authority) lässt sich nur im Dashboard ändern: über die API ergibt sie 400 role_dashboard_only.

Wird der Ablauf einer abgelaufenen Berechtigung nach vorn verschoben, ist sie wieder aktiv, und das Limit von 50 aktiven Berechtigungen gilt wie beim Erstellen. Eine widerrufene Berechtigung ergibt 404. Die Änderung wird mit dem API-Schlüssel oder der App, die sie vorgenommen hat, im Zugriffsprotokoll festgehalten.

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. Erfordert ein zahlendes Konto. Zählt als ein v1-Schreibvorgang. Unterstützt Idempotency-Key.

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.

Body-Felder

  • label

    string (1-120 chars)

    Neues Label.

  • purpose

    string (max 500 chars)

    Neuer Zweck.

  • scope

    object

    Neuer Umfang, gleiche Form wie beim Erstellen. Eine Käufer-Berechtigung muss bei Pässen bleiben.

  • evidence

    object

    Neuer Nachweis { type, reference, note? }.

  • expiresInDays

    integer | null (1-1825)

    Tage ab jetzt bis zum Ablauf; null = kein Ablauf.

Anfrage

curl -sS -X PATCH https://app.tracepass.eu/api/v1/access-grants/6650c1d2e3f4a5b6c7d8e9f0 \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "expiresInDays": 90 }'

Antwort

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