Meine Organisationen auflisten

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

Listet die Organisationen auf, zu denen der authentifizierte Benutzer in einer Anwendung wechseln kann: Organisationen, in denen der Benutzer eine aktive Mitgliedschaft hat, die aktiv sind und für die die Anwendung aktiviert ist, sortiert nach Slug, maximal 100. Dies ist die Liste, die ein Organisationsumschalter anzeigt, und dieselbe Liste, die die gehostete Organisationsauswahl beim Anmelden anbietet. Dadurch wird nie eine Organisation angezeigt, die die Anwendung nicht nutzen kann. Kein Eintrag wird als aktuell markiert: Die Organisation, an die das Token Ihrer Anwendung gebunden ist, steht im Claim org_id des Tokens. Das Lesen verä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.

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

Anfrage

Header:

Header	Pflicht	Beschreibung
`Idp-Client`	ja	SDK-Kennung.

Query-Parameter:

Parameter	Pflicht	Beschreibung
`client_id`	ja	Die `client_id` der First-Party-Anwendung, in der der Umschalter läuft.

Kein Body.

Antwort

200 OK mit {"data": [...], "truncated": false}.

Jeder Eintrag enthält: id (org_…, dieselbe Form wie der Claim org_id des Tokens und der Parameter organization), slug, name (Anzeigename, aus dem Steuer- und bidirektionale Zeichen entfernt wurden; der Slug, wenn die Organisation keinen Namen hat; als reinen Text darstellen). truncated ist true, wenn der Benutzer mehr solche Organisationen hat, als aufgelistet werden.

Fehler

Status	Code	Wann
401	`unauthenticated`	Kein gültiges Sitzungs-Cookie.
403	`headless_not_allowed`	Die Anwendung ist eine Drittanbieter-Anwendung.
422	`validation_failed`	`client_id` fehlt, ist leer, länger als 255 Zeichen, mehrfach angegeben oder unbekannt (`/client_id`).
503	`temporarily_unavailable`	Das Mitgliederverzeichnis hat nicht geantwortet; versuchen Sie es später erneut.

Beispiel

curl "https://example.keenauth.app/fapi/v1/me/organizations?client_id=app_01j9zzzzzzzzzzzzzzzzzzzz" \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt

{
  "data": [
    {
      "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
      "slug": "acme",
      "name": "Acme"
    }
  ],
  "truncated": false
}

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).