Zum Inhalt springen

Management-API

Verwalten Sie Organisationsressourcen mit scoped API-Schlüsseln im Backend.Ihrem Backend zu verwalten.

Als Markdown anzeigen

Authentifizierung

Management-API-Aufrufe verwenden Authorization: Bearer sk_live_* oder Authorization: Bearer sk_test_*. Schlüssel sind pro Organisation begrenzt und werden vor jeder Ressourcenaktion geprüft.

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/users/:userId/emailAddresses Primäre E-Mail-Adressen hinzufügen, entfernen und festlegen. Implementiert
/v1/users/:userId/phoneNumbers Primäre Telefonnummern hinzufügen, entfernen und festlegen. Implementiert
/v1/allowlist-identifiers Erlaubte E-Mail- oder Domain-Kennungen erstellen, löschen und auflisten. Implementiert
/v1/oauth-applications OAuth-Anwendungen verwalten, bei denen XID als Identitätsanbieter fungiert. Implementiert
/v1/redirect-urls Erlaubte Redirect-URL-Werte registrieren und entfernen. 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/billing Pläne lesen, Abonnements verwalten und Zahlungsverlauf anzeigen. Geplant

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