• logto
  • management-api
  • api
  • machine-to-machine
  • organization
  • user-profile
  • user-search
  • audit-log
  • migration

Zbadanie pełnego potencjału Logto Management API

W tym artykule ponownie podkreślimy definicję Logto Management API, wyjaśnimy, jak ono działa, i zaprezentujemy typowe scenariusze, które zwiększą twoją produktywność i odblokują więcej przypadków użycia.

Guamian
Guamian
Product & Design

Jako usługa infrastrukturalna, staramy się, aby korzystanie z naszego Logto Management API było łatwiejsze i szybsze. Niedawno zaktualizowaliśmy nasze przewodniki i samouczki. W tym artykule ponownie podkreślimy definicję Logto Management API, wyjaśnimy, jak ono działa, i zaprezentujemy typowe scenariusze, które zwiększą twoją produktywność i odblokują więcej przypadków użycia.

Czym jest Logto Management API

Logto Management API to potężny zestaw wstępnie zbudowanych interfejsów API, który daje deweloperom pełną kontrolę nad dostosowaniem wdrożenia do ich potrzeb produktów i stosów technologicznych.

Jest on wymieniony na liście zasobów API i nie można go usunąć ani zmodyfikować. Wszystko, co możesz zrobić w Logto Admin Console, możesz również zrobić za pomocą Logto Management API.

Jego identyfikator ma wzór https://[tenant-id].logto.app/api

Logto management API

Logto management API - 2

Zawiera ono domyślnie all uprawnienia. W miarę rozwoju Logto będziemy nadal wprowadzać bardziej szczegółowe uprawnienia.

Dzięki Logto Management API możesz uzyskać dostęp do solidnych usług backendowych Logto, które są wysoko skalowalne i mogą być wykorzystywane w wielu scenariuszach. Aby dowiedzieć się więcej o dostępnych API, odwiedź Logto API references.

Typowe scenariusze użycia management API

Nasi deweloperzy wdrożyli wiele dodatkowych funkcji za pomocą naszego Management API. Wierzymy, że nasze API jest wysoce skalowalne i może wspierać szeroki wachlarz twoich potrzeb. Oto kilka przykładów scenariuszy, które nie są możliwe w Logto Admin Console, ale mogą być osiągnięte za pomocą Management API.

Implementacja profilu użytkownika z niestandardowym UI

Logto obecnie nie dostarcza wbudowanego rozwiązania UI dla profili użytkowników. Uznajemy, że profile użytkowników są ściśle związane z atrybutami biznesowymi i produktowymi. Podczas gdy pracujemy nad określeniem najlepszego podejścia, sugerujemy korzystanie z naszych interfejsów API w celu stworzenia własnego rozwiązania. Na przykład, możesz wykorzystać nasze interfejsy API interakcji, profilu i kodu weryfikacyjnego, aby opracować niestandardowe rozwiązanie, które spełni twoje potrzeby. Przygotowaliśmy dedykowaną stronę User Profile z samouczkami i przewodnikami.

Ciekawym przykładem jest to, że funkcja profilu użytkownika Logto Cloud została zbudowana za pomocą Logto Management API.

Ustawienia konta

Implementacja zarządzania organizacją z niestandardowym UI

Jeśli korzystasz z funkcji organization, aby zbudować swoją aplikację wielotenantową, możesz potrzebować Logto management API do zadań takich jak zaproszenia do organizacji i zarządzanie członkami.

Podobnie, funkcja zaproszeń i współpracy w Logto Cloud została również zbudowana za pomocą Logto Management API.

Organizacja

Zaproś członków do Org

Aby rozszerzyć ten przypadek, w twoim produkcie SaaS, gdzie masz zarówno administratorów, jak i członków w tenantcie, Logto management API może pomóc ci stworzyć niestandardowy portal administratora dostosowany do potrzeb twojej firmy. Zobacz to, aby uzyskać więcej szczegółów.

Zaawansowane wyszukiwanie użytkowników

Logto Admin Console obsługuje podstawowe funkcje wyszukiwania i filtrowania. Jeśli potrzebujesz bardziej zaawansowanych opcji, aby dostosować swoją usługę zarządzania użytkownikami do potrzeb swojej firmy, możesz skorzystać z Logto Management API. Podporządkowuje się ono zaawansowanym opcjom wyszukiwania, takim jak:

  1. Rozmyte wyszukiwanie
  2. Dokładne dopasowanie
  3. Czułość na wielkość liter
  4. Wskazanie pól

Sprawdź nasze samouczki i przewodniki Advanced User Search.

Wykorzystanie logów Logto do budowy własnych usług

Log audytu Logto umożliwia łatwe monitorowanie aktywności użytkowników i zdarzeń. Stanowi to solidną podstawę dla różnych scenariuszy zarządzania użytkownikami oraz kontroli stanu zdrowia systemu.

Logi audytu

Korzystając z management API, możesz uzyskać dostęp do danych logów audytu w czasie rzeczywistym. Pozwala to na zaprojektowanie własnego modelu schematu i pulpitu nawigacyjnego przy użyciu danych logów uzyskanych z Logto.

Migracja i importowanie użytkowników do Logto

Korzystając z Management API, możesz łatwo zaimportować dane użytkowników, zwłaszcza jeśli chcesz przeprowadzić migration do Logto.

Po przygotowaniu danych użytkownika i ustawieniu szyfrowania haseł oraz schematu użytkownika, skonfiguruj połączenie Management API i wywołaj API create user, aby zaimportować dane użytkowników. Aby dowiedzieć się więcej o migracji, zapoznaj się z tym dokumentem.

Jak uzyskać dostęp do Logto Management API

Utwórz aplikację M2M

Wybierz typ aplikacji M2M i rozpocznij proces tworzenia. Po utworzeniu zostaniesz przekierowany do modułu, w którym możesz przypisać rolę machine-to-machine.

Po podaniu nazwy i opisu zobaczysz moduł, który poprosi cię o przypisanie roli. Ten moduł zawiera wszystkie role M2M, a role wskazane ikoną Logto oznaczają, że te role zawierają uprawnienia Logto management API.

Przypisanie ról M2M obejmuje uprawnienia Logto management API dla twojej aplikacji M2M.

Przypisz rolę M2M

Dlaczego warto używać machine-to-machine i przypisywać role machine-to-machine?

Dlaczego Logto umożliwia komunikację M2M (Machine-to-Machine) w celu wywoływania Logto Management API zamiast korzystania z kluczy API?

Logto zajmuje się zarządzaniem tożsamościami klientów i ściśle przestrzega otwartych standardów, takich jak OAuth 2.0 i OpenID Connect. Tokeny M2M oferują bezpieczne interakcje serwer-serwer z określonymi zakresami, zapewniając lepsze zabezpieczenie niż statyczne klucze API. W przeciwieństwie do kluczy API, które nie wygasają i stanowią większe ryzyko w przypadku kompromitacji, tokeny M2M mają określone czasy wygaśnięcia, co ogranicza okno potencjalnego nadużycia.

W Logto używamy kontroli dostępu opartej na rolach (RBAC) do ochrony i zarządzania dostępem do Logto Management API. Ten diagram podmiotów pokazuje, jak to działa.

Zależność uprawnień, zasobów API, ról i aplikacji machine-to-machine.

Zależność uprawnień, zasobów API, ról i aplikacji machine-to-machine.

Pobierz token dostępu

Podstawy dotyczące żądania tokena dostępu

Aplikacja M2M wykonuje POST zapytanie do punktu końcowego tokena, aby pobrać token dostępu, dodając następujące parametry w formacie application/x-www-form-urlencoded w treści żądania HTTP:

  • grant_type: musi być ustawiony na client_credentials
  • resource: wskaźnik zasobu, do którego chcesz uzyskać dostęp
  • scope: Zakres żądania dostępu

Musisz również dołączyć swoje dane uwierzytelniające M2M do punktu końcowego tokena, aby uwierzytelnić swoją aplikację M2M. Osiąga się to poprzez dodanie nagłówka Authorization przy użyciu Basic authentication, gdzie nazwa użytkownika to App ID, a hasło to App Secret.

Możesz znaleźć App ID i App Secret na stronie szczegółów swojej aplikacji M2M:

Dane aplikacji

Przykład zapytania o token dostępu Logto Management API to:

Pobierz token dostępu dla Logto Management API

Logto dostarcza wbudowany zasób „Logto Management API”, jest to zasób typu readonly z uprawnieniami all do dostępu do Logto Management API, możesz to zobaczyć na swojej liście zasobów API. Wskaźnik zasobu API ma wzór https://{YOUR_TENANT_ID}.logto.app/api, i to będzie wartość zasobu użyta w treści żądania tokena dostępu.

Status Management API

Przed uzyskaniem dostępu do Logto Management API, upewnij się, że twoja aplikacja M2M ma przypisane role M2M, które zawierają uprawnienie all z tego wbudowanego zasobu „Logto Management API”.

Teraz skomponuj wszystko, co posiadasz i wyślij żądanie:

Odpowiedź na token

Pomyślna odpowiedź może wyglądać następująco:

Dostęp do Logto Manage API przy użyciu Access Token

Możesz zauważyć, że odpowiedź na token ma pole token_type, które jest ustalone na Bearer. Tak więc powinieneś umieścić Token Dostępu w polu Authorization w nagłówkach HTTP z formatem Bearer (Bearer YOUR_TOKEN).

Teraz możesz uzyskać dostęp do Logto Management API, wysyłając żądanie do punktu końcowego Logto Management API https://[your-tenant-id].logto.app/api, aby uzyskać wszystkie aplikacje w Logto

Powiązane zasoby

Oto niektóre powiązane zasoby, które zgłębiają nasze wcześniejsze spostrzeżenia i strategie dotyczące korzystania z Logto Management API. Te materiały obejmują różne aspekty, w tym najlepsze praktyki, wskazówki dotyczące wdrożenia i przypadki użycia, aby pomóc ci w pełnym wykorzystaniu Logto Management API w twoich projektach.