Deutsch
  • logto
  • management-api
  • api
  • maschine-zu-maschine
  • organisation
  • benutzerprofil
  • benutzersuche
  • audit-log
  • migration

Das volle Potenzial der Logto Management API erforschen

In diesem Artikel werden wir die Definition der Logto Management API erneut betonen, erklären, wie sie funktioniert, und typische Szenarien vorstellen, um deine Produktivität zu steigern und weitere Anwendungsfälle zu erschließen.

Guamian
Guamian
Product & Design

Als Infrastrukturdienstleistung bemühen wir uns, die Nutzung unserer Logto Management API einfacher und schneller zu gestalten. Wir haben kürzlich unsere Anleitungen und Tutorials aktualisiert. In diesem Artikel werden wir die Definition der Logto Management API erneut betonen, erklären, wie sie funktioniert, und typische Szenarien vorstellen, um deine Produktivität zu steigern und weitere Anwendungsfälle zu erschließen.

Was ist die Logto Management API

Die Logto Management API ist ein leistungsstarkes Set vorgefertigter APIs, das Entwicklerinnen und Entwicklern die volle Kontrolle gibt, ihre Implementierung an die Bedürfnisse ihres Produkts und technischen Stacks anzupassen.

Sie ist in der API-Ressourcenliste aufgeführt und kann nicht gelöscht oder geändert werden. Alles, was im Logto Admin Console möglich ist, kann auch mit der Logto Management API durchgeführt werden.

Ihr Identifikator folgt dem Format https://[tenant-id].logto.app/api

Logto Management API

Logto Management API - 2

Sie enthält standardmäßig alle Berechtigungen. Mit dem Wachstum von Logto werden wir die Berechtigungen weiterhin granularisieren.

Mit der Logto Management API kannst du auf die robusten Backend-Dienste von Logto zugreifen, die hoch skalierbar sind und in einer Vielzahl von Szenarien genutzt werden können. Um mehr über die verfügbaren APIs zu erfahren, besuche bitte die Logto API Referenzen.

Typische Szenarien für die Nutzung der Management API

Unsere Entwicklerinnen und Entwickler haben viele zusätzliche Funktionen mithilfe unserer Management API implementiert. Wir sind der Meinung, dass unsere API hoch skalierbar ist und eine Vielzahl deiner Bedürfnisse unterstützen kann. Hier sind einige Beispiele für Szenarien, die mit dem Logto Admin Console nicht möglich sind, aber durch die Management API erreicht werden können.

Benutzerprofil mit eigenem UI umsetzen

Logto bietet derzeit keine vorkonfektionierte UI-Lösung für Benutzerprofile. Wir erkennen an, dass Benutzerprofile eng mit Geschäfts- und Produktattributen verbunden sind. Während wir daran arbeiten, den besten Ansatz zu finden, schlagen wir vor, unsere APIs zu nutzen, um deine eigene Lösung zu erstellen. Zum Beispiel kannst du unsere Interaktions-API, Profil-API und Verifizierungscode-API nutzen, um eine maßgeschneiderte Lösung zu entwickeln, die deinen Bedürfnissen entspricht. Wir haben eine dedizierte Seite Benutzerprofil für Tutorials und Anleitungen vorbereitet.

Ein interessantes Beispiel ist, dass das Benutzerprofil-Feature von Logto Cloud unter Verwendung der Logto Management API erstellt wurde.

Kontoeinstellungen

Organisationsmanagement mit eigenem UI umsetzen

Wenn du die Organisations Funktion zur Erstellung deiner Multi-Tenant-App verwendest, könnte die Logto Management API für Aufgaben wie Organisations-Einladungen und Mitgliederverwaltung erforderlich sein.

Ähnlich wurde auch das Einladung- und Kollaborations-Feature von Logto Cloud mithilfe der Logto Management API erstellt.

Organisation

Mitglieder zur Organisation einladen

Um dieses Szenario zu erweitern: Für dein SaaS-Produkt, wo du sowohl Admins als auch Mitglieder im Tenant hast, kann dir die Logto Management API helfen, ein maßgeschneidertes Admin-Portal zu erstellen, das genau auf deine Geschäftsanforderungen zugeschnitten ist. Weitere Details findest du hier.

Erweiterte Benutzersuche

Das Logto Admin Console unterstützt grundlegende Such- und Filterfunktionen. Wenn du erweiterte Optionen benötigst, um deinen Benutzerverwaltungsdienst an deine Geschäftsbedürfnisse anzupassen, kannst du die Logto Management API verwenden. Sie unterstützt erweiterte Suchoptionen wie:

  1. Fuzzy-Suche
  2. Exakte Übereinstimmung
  3. Groß-/Kleinschreibung
  4. Felder spezifizieren

Sieh dir unsere Erweiterte Benutzersuche Tutorials und Anleitungen an.

Logtos Protokolle nutzen, um eigene Dienste zu erstellen

Das Audit-Log von Logto ermöglicht es dir, Benutzeraktivitäten und Ereignisse einfach zu überwachen. Es bietet eine starke Grundlage für verschiedene Szenarien im Bereich der Benutzerverwaltung und Gesundheitschecks.

Audit-Protokolle

Mithilfe der Management API kannst du in Echtzeit auf Audit-Protokolldaten zugreifen. Dadurch kannst du dein eigenes Schema-Modell und Dashboard mithilfe der von Logto erhaltenen Protokolldaten entwerfen.

Benutzer auf Logto migrieren und importieren

Die Management API kann dir einfach helfen, Benutzerdaten zu importieren, insbesondere wenn du eine Migration zu Logto durchführen möchtest.

Nachdem du die Benutzerdaten vorbereitet und das Passworthashing und das Benutzerschema eingerichtet hast, richte die Verbindung zur Management API ein und wir rufen die Benutzer erstellen-API auf, um die Benutzerdaten zu importieren. Um mehr über die Migration zu erfahren, sieh dir dieses Dokument an.

Wie man auf die Logto Management API zugreift

Eine M2M-App erstellen

Wähle den M2M-App-Typ und starte den Erstellungsprozess. Nach der Erstellung wirst du zu einem Modul weitergeleitet, in dem du eine Maschine-zu-Maschine-Rolle zuweisen kannst.

Nachdem du einen Namen und eine Beschreibung angegeben hast, siehst du ein Modul, in dem du eine Rolle zuweisen kannst. Dieses Modul enthält alle M2M-Rollen, Rollen mit einem Logto-Symbol bedeuten, dass diese Rollen Logto-Management-API-Berechtigungen enthalten.

Die Zuweisung von M2M-Rollen enthält Logto-Management-API-Berechtigungen für deine M2M-App.

M2M-Rolle zuweisen

Warum Maschine-zu-Maschine-Kommunikation und warum Maschine-zu-Maschine-Rollen zuweisen?

Warum erlaubt Logto M2M (Machine-to-Machine) Kommunikation, um die Logto Management API aufzurufen, anstatt API-Schlüssel zu verwenden?

Logto beschäftigt sich mit der Verwaltung von Kundenidentitäten und folgt strikt offenen Standards wie OAuth 2.0 und OpenID Connect. M2M-Tokens bieten sichere Server-zu-Server-Interaktionen mit bestimmten Scopes und bieten eine bessere Sicherheit als statische API-Schlüssel. Im Gegensatz zu API-Schlüsseln, die nicht ablaufen und ein höheres Risiko bei einem Missbrauch darstellen, haben M2M-Tokens festgelegte Ablaufzeiten, wodurch das Zeitfenster für potenziellen Missbrauch eingeschränkt wird.

In Logto verwenden wir rollenbasierte Zugriffskontrolle (RBAC), um den Zugriff auf die Logto Management API zu schützen und zu verwalten. Dieses Entitätsdiagramm zeigt, wie es funktioniert.

 Die Beziehung zwischen Berechtigungen, API-Ressourcen, Rollen und Maschine-zu-Maschine-Anwendung.

Die Beziehung zwischen Berechtigungen, API-Ressourcen, Rollen und Maschine-zu-Maschine-Anwendung.

Ein Zugriffstoken abrufen

Grundlagen zur Zugriffstoken-Anfrage

Eine M2M-App macht eine POST-Anfrage an den Token-Endpunkt, um ein Zugriffstoken abzurufen, indem die folgenden Parameter im application/x-www-form-urlencoded Format im HTTP-Request-Entity-Body hinzugefügt werden:

  • grant_type: muss auf client_credentials gesetzt werden
  • resource: Der Ressource-Indikator, auf den du zugreifen möchtest
  • scope: Der Umfang der Zugriffsanfrage

Und du musst auch deine M2M-Anmeldeinformationen angeben, damit der Token-Endpunkt deine M2M-App authentifizieren kann. Dies erfolgt durch Hinzufügen eines Authorization Headers mithilfe der Basis-Authentifizierung, wobei der Benutzername die App-ID und das Passwort das App-Geheimnis ist.

Du kannst die App-ID und das App-Geheimnis auf der Detailseite deiner M2M-Anwendung finden:

App-Anmeldeinformationen

Ein Beispiel für die Logto Management API Zugriffstoken-Anfrage lautet:

Zugriffstoken für Logto Management API abrufen

Logto bietet eine integrierte „Logto Management API“ Ressource, es handelt sich um eine schreibgeschützte Ressource mit der Berechtigung alle für den Zugriff auf die Logto Management API, du kannst sie in deiner API-Ressourcenliste sehen. Der API-Indikator der Ressource hat das Format https://{DEIN_TENANT_ID}.logto.app/api und dies wird dein Ressourcentwert sein, der im Body der Zugriffstoken-Anfrage verwendet wird.

Management API Status

Bevor du auf die Logto Management API zugreifst, stelle sicher, dass deiner M2M-App M2M-Rollen zugewiesen wurden, die die Berechtigung alle von dieser integrierten „Logto Management API“ Ressource enthalten.

Nun, alles zusammenstellen und die Anfrage senden:

Token-Antwort

Ein erfolgreicher Antworttext würde so aussehen:

Zugriff auf die Logto Management API mithilfe des Zugriffstokens

Dir ist vielleicht aufgefallen, dass die Token-Antwort ein token_type-Feld enthält, das auf Bearer festgelegt ist. Daher solltest du das Zugriffstoken im Authorization-Feld der HTTP-Headers mit dem Bearer-Format (Bearer YOUR_TOKEN) hinzufügen.

Jetzt kannst du auf die Logto Management API zugreifen, indem du den Logto Management API Endpunkt https://[dein-tenant-id].logto.app/api aufrufst, um alle Anwendungen in Logto zu erhalten.

Verwandte Ressourcen

Hier sind einige verwandte Ressourcen, die auf unsere früheren Einsichten und Strategien zur Nutzung der Logto Management API eingehen. Diese Materialien decken verschiedene Aspekte ab, darunter Best Practices, Implementierungstipps und Anwendungsfälle, um dir zu helfen, das Beste aus der Logto Management API für deine Projekte herauszuholen.