Meine Organisationsvorschläge auflisten

GET /fapi/v1/me/organization-suggestions · wird vom Anmelde-Host der Umgebung aufgerufen

Listet die Organisationen auf, denen der authentifizierte Benutzer aufgrund der Domain einer seiner bestätigten E-Mail-Adressen beitreten kann. Eine Organisation wird vorgeschlagen, wenn sie aktiv ist, diese Domain mit auf suggest gesetzter Domain-Erfassung verifiziert hat und der Benutzer dort keine Mitgliedschaft besitzt (eine entfernte oder verlassene Mitgliedschaft zählt ebenfalls, daher wird die Organisation nie erneut vorgeschlagen). Pro Organisation wird ein Eintrag zurückgegeben, sortiert nach Slug, höchstens 20. Eine Organisation, die der Benutzer dreimal abgelehnt hat, wird nicht aufgeführt. Ist die Standard-Mitgliederrolle der Umgebung durch Domain-Erfassung nicht vergebbar (eine Administratorrolle, eine privilegierte Rolle oder eine Rolle mit Systemberechtigungen über das Lesen der Organisation und ihrer Mitglieder hinaus), ist die Liste leer. Das Lesen ändert nichts und erfordert keine kürzlich verifizierte Sitzung. Erforderlich ist das Cookie __Host-idp_session des authentifizierten Benutzers; fehlt das Cookie, ist es abgelaufen oder widerrufen, wird 401 unauthenticated zurückgegeben. Eine First-Party-Anwendung auf einem anderen Origin kann stattdessen ihr Front-API-Zugriffstoken senden (Authorization: DPoP <token> mit einem DPoP-Proof; siehe Front-API-Zugriffstoken).

Mit @keenauth/js: await keenauth.organizations.suggestions().

Anfrage

Header:

Header Erforderlich Beschreibung
Idp-Client ja Kennung des SDK.

Keine Abfrageparameter. Kein Body.

Antwort

200 OK mit {"data": [...]}. Die Antwort wird nicht zwischengespeichert (Cache-Control: no-store).

Jeder Eintrag enthält: id (odm_…, der bestätigte Domain-Datensatz; damit treten Sie bei oder lehnen ab), domain (die passende E-Mail-Domain) und organization mit id (org_…), slug und name (Anzeigename, aus dem Steuer- und bidirektionale Zeichen entfernt wurden; der Slug, wenn die Organisation keinen Namen hat; als Klartext darstellen).

Fehler

Status Code Wann
401 unauthenticated Kein gültiges Sitzungs-Cookie oder Front-API-Zugriffstoken.
503 temporarily_unavailable Das Mitgliederverzeichnis hat nicht geantwortet; wiederholen Sie die Anfrage später.

Beispiel

curl https://example.keenauth.app/fapi/v1/me/organization-suggestions \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt
{
  "data": [
    {
      "id": "odm_01j9a5c4000000000000000001",
      "domain": "acme.example",
      "organization": {
        "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
        "slug": "acme",
        "name": "Acme"
      }
    }
  ]
}

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 keine besonderen Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung) in irgendeinem Feld.