Zum Inhalt springen

Management-API

Verwalten Sie Organisationsressourcen mit bereichsgebundenen API-Schlüsseln in Ihrem Backend.

Als Markdown anzeigen

Authentifizierung

Aufrufe der Management API verwenden Authorization: Bearer sk_live_* oder Authorization: Bearer sk_test_*. Die Schlüssel sind auf den aufgelösten Mandanten beschränkt. Organisationsressourcen prüfen zusätzlich, ob die angeforderte Organisation zu diesem Mandanten gehört.

curl https://xid.dev/v1/users \
  -H 'Authorization: Bearer sk_live_xxx'

Ressourcen

Ressource Funktionen Zustand
/v1/users Benutzer erstellen, lesen, aktualisieren, sperren, entsperren, exportieren und entfernen. Implementiert
/v1/organizations Organisationen, Domains, Branding und Einstellungen verwalten. Implementiert
/v1/organizations/:orgId/memberships Mitglieder auflisten, erstellen, Rolle aktualisieren und entfernen. Implementiert
/v1/organizations/:orgId/invitations Einladungen erstellen (mit Massenlimit), widerrufen und auflisten. Implementiert
/v1/sessions Benutzersitzungen auflisten, abrufen und widerrufen. Implementiert
/v1/applications OAuth-Klienten, Weiterleitungs-URIs, Berechtigungen, Tokenrichtlinie und Geheimnisse registrieren. Implementiert
/v1/connections Upstream Enterprise SSO-Verbindungen verwalten. Implementiert
/v1/directories SCIM-Verzeichnisse erstellen und Verzeichnis-Token rotieren. Implementiert
/v1/roles Benutzerdefinierte Rollen erstellen, lesen, aktualisieren und löschen. Implementiert
/v1/permissions Berechtigungen erstellen, lesen, aktualisieren und löschen. Implementiert
/v1/project-grants Projektberechtigungen erstellen, auflisten, abrufen, widerrufen und löschen. Implementiert
/v1/user-grants Weisen Sie bereichsbezogene Benutzerberechtigungen zu, listen Sie sie auf, rufen Sie sie ab, widerrufen Sie sie und löschen Sie sie. Implementiert
/v1/organizations/:orgId/domains Organisationsdomänen auflisten, erstellen und entfernen. Implementiert
/v1/organizations/:orgId/custom-hostnames Erstellen, überprüfen, aktualisieren und entfernen Sie benutzerdefinierte Hostnamen. Implementiert
/v1/organizations/:orgId/audit-events Organisationsbezogene Audit-Ereignisse mit Cursor-Paginierung lesen. Implementiert
/v1/webhooks Webhook-Endpunkte erstellen, auflisten, aktualisieren und löschen. Implementiert
/v1/api-keys Organisations-API-Schlüssel erstellen, auflisten und widerrufen. Implementiert
/v1/organizations/:orgId/scim-targets Erstellen, aktualisieren, synchronisieren und entfernen Sie ausgehende SCIM-Ziele. Implementiert

Paginierung und Fehler

Listen-Endpunkte geben ein Datenarray und Cursor-Metadaten zurück. Fehler verwenden strukturiertes JSON mit stabilem Code, lesbarer Meldung und optionalen Metadaten für Feldvalidierung.

Navigation

Suchbegriff eingeben...

Mit den Pfeiltasten navigierenEingabetaste zum AuswählenEscape zum Schließen