Organisation abrufen

GET /fapi/v1/organizations/{org_id} · aufgerufen vom Anmeldehost der Umgebung

Gibt das Profil einer Organisation so zurück, wie es der Administrator sieht: Name, Slug, Status, Markenfarbe und Version. Dies ist, was ein Organisationsprofil-Bildschirm anzeigt. 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-App auf einem anderen Origin kann stattdessen ihr Front-API-Zugriffstoken senden (Authorization: DPoP <token> mit einem DPoP-Proof; siehe Front-API-Zugriffstoken). Der Benutzer muss ein aktives Mitglied der Organisation sein und die Berechtigung idp_org:read besitzen. Ein Benutzer, der kein Mitglied ist, erhält 404 not_found, damit die Existenz der Organisation nicht offengelegt wird; ein Mitglied ohne die Berechtigung erhält 403 insufficient_permissions.

Mit @keenauth/js: await keenauth.organizations.get(orgId).

Anfrage

Header:

Header Erforderlich Beschreibung
Idp-Client ja SDK-Kennung.

org_id: die Kennung der Organisation (org_…).

Kein Body.

Antwort

200 OK mit ETag: "<version>".

Feld Beschreibung
id org_….
name Anzeigename; als Klartext darstellen.
slug Der Slug der Organisation.
status active, disabled oder pending_deletion.
brand_color #RRGGBB, oder null, wenn nicht gesetzt.
deletion_due_at Nur während die Organisation zur Löschung vorgemerkt ist: wann sie gelöscht wird.
created_at, updated_at Zeitpunkte nach RFC 3339.
version Die Version, die der ETag trägt; bei einer Aktualisierung als If-Match senden.

Fehler

Status Code Wann
401 unauthenticated Kein gültiges Sitzungs-Cookie.
403 insufficient_permissions Der Benutzer hat in der Organisation nicht idp_org:read.
404 not_found Für diesen Benutzer existiert keine solche Organisation; eine unbekannte, fehlerhafte oder fremde Kennung führt zur gleichen Antwort.
503 service_unavailable Vorübergehend nicht verfügbar; wiederholen Sie die Anfrage nach Retry-After.

Beispiel

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

{
  "id": "org_01jbz6x8kq3m2n4p5r6s7t8v9a",
  "name": "Acme",
  "slug": "acme",
  "status": "active",
  "brand_color": "#112233",
  "created_at": "2026-11-03T09:00:00Z",
  "updated_at": "2026-11-03T09:30:00Z",
  "version": 4
}