Einladung widerrufen

POST /v1/invitations/{invitation_id}:revoke · Berechtigung invitations:write

Widerruft eine ausstehende Einladung: Ihr Link funktioniert danach nicht mehr, und ihre E-Mail-Adresse wird gelöscht. Der Schreibvorgang wird als invitation.revoked protokolliert.

Anfrage

Feld Typ Pflichtfeld Beschreibung
invitation_id path ja Einladungs-ID (inv_…).

Kein Anfragekörper.

Antwort

200 OK mit der widerrufenen Einladung.

{
  "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "email": null,
  "role_ids": [
    "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
  ],
  "application_id": null,
  "delivery": "link_only",
  "delivery_status": "not_sent",
  "status": "revoked",
  "send_count": 1,
  "last_sent_at": "2026-10-12T09:31:00.123456Z",
  "expires_at": "2026-10-19T09:31:00.123456Z",
  "accepted_user_id": null,
  "accepted_at": null,
  "revoked_at": "2026-10-12T10:00:00Z",
  "created_at": "2026-10-12T09:31:00.123456Z",
  "updated_at": "2026-10-12T09:31:00.123456Z",
  "version": 2
}

Fehler

HTTP code Wann
404 not_found Die Einladung existiert in dieser Umgebung nicht.
409 conflict Die Einladung ist nicht ausstehend.
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder widerrufen.
403 insufficient_permissions Den Anmeldedaten fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach Ablauf des Retry-After-Zeitraums.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; wiederholen Sie die Anfrage nach Ablauf des Retry-After-Zeitraums.

Beispiel

curl -i -X POST "https://api.eu.keenauth.com/v1/invitations/inv_01j9xt9v3w4y8z0a2b4c6d8e0g:revoke" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Personenbezogene Daten

Dieser Endpunkt verarbeitet personenbezogene Daten: Organisationsmitgliedschaften und Einladungen. Personenbezogene Daten in den KeenAuth-APIs beschreibt, was gespeichert wird, wie lange es aufbewahrt wird und wie es gelöscht wird. Übermitteln Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).