Einladung widerrufen

POST /fapi/v1/organizations/{org_id}/invitations/{invitation_id}:revoke · wird vom Anmeldehost der Umgebung aufgerufen

Widerruft eine ausstehende Einladung. Die Antwort ist die widerrufene Einladung; ihre Adresse wurde gelöscht (email ist null). Eine Einladung, die nicht mehr ausstehend ist (angenommen, abgelaufen oder bereits widerrufen), liefert 422 invitation_invalid.

Erforderlich ist das Cookie __Host-idp_session des authentifizierten Benutzers mit einem exakten Origin, oder ein Zugriffstoken der Front API einer Anwendung der ersten Partei (Authorization: DPoP <token> mit einem DPoP-Nachweis; siehe Zugriffstoken der Front API). Der Benutzer muss aktives Mitglied der Organisation sein und die Berechtigung idp_members:invite besitzen. Ein Benutzer, der kein Mitglied ist, erhält 404 not_found; ein Mitglied ohne die Berechtigung erhält 403 insufficient_permissions. Nur ein Mitglied mit der Administratorrolle kann eine Einladung mit einer privilegierten Rolle widerrufen (403 role_not_assignable).

Mit @keenauth/js: await keenauth.organizations.revokeInvitation(orgId, invitationId).

Anfrage

Header:

Header Erforderlich Beschreibung
Idp-Client ja Kennung des SDK.
Origin ja, bei Verwendung des Cookies https://<Anmeldehost>.

org_id: die Kennung der Organisation (org_…). invitation_id: die Kennung der Einladung (inv_…), also die id von der Einladung.

Kein Body.

Antwort

200 OK mit der Einladung und ETag: "<version>".

Fehler

Status Code Wann
401 unauthenticated Kein gültiges Sitzungs-Cookie oder Token.
403 insufficient_permissions Der Benutzer besitzt idp_members:invite in der Organisation nicht.
403 role_not_assignable Die Einladung enthält eine privilegierte Rolle und der Benutzer hat die Administratorrolle nicht.
403 origin_not_allowed Der Origin stimmt nicht überein.
404 not_found Keine solche Organisation oder Einladung für diesen Benutzer; eine unbekannte, fehlerhafte oder fremde Kennung führt zu derselben Antwort.
409 organization_disabled Die Organisation ist deaktiviert oder zur Löschung vorgemerkt (organization_pending_deletion).
422 invitation_invalid Die Einladung ist nicht mehr ausstehend.
503 service_unavailable Vorübergehend nicht verfügbar; wiederholen Sie die Anfrage nach Retry-After.

Beispiel

curl -X POST "https://example.keenauth.app/fapi/v1/organizations/org_01jbz6x8kq3m2n4p5r6s7t8v9a/invitations/inv_01jbz6x8kq3m2n4p5r6s7t8v9d:revoke" \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -b cookies.txt
{
  "id": "inv_01jbz6x8kq3m2n4p5r6s7t8v9d",
  "email": null,
  "role_ids": ["rol_01jbz6x8kq3m2n4p5r6s7t8v9w"],
  "delivery": "email",
  "delivery_status": "sent",
  "status": "revoked",
  "send_count": 1,
  "last_sent_at": "2026-11-03T10:00:00Z",
  "expires_at": "2026-11-10T10:00:00Z",
  "accepted_user_id": null,
  "accepted_at": null,
  "revoked_at": "2026-11-03T11:00:00Z",
  "created_at": "2026-11-03T10:00:00Z",
  "updated_at": "2026-11-03T11:00:00Z",
  "version": 2
}

Personenbezogene Daten

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