Utforska den fulla potentialen hos Logto Management API
I denna artikel kommer vi att betona definitionen av Logto Management API, förklara hur det fungerar och visa typiska scenarier för att öka din produktivitet och frigöra fler användningsfall.
Product & Design
Som en infrastrukturservice strävar vi efter att göra användningen av vårt Logto Management API enklare och snabbare. Vi har nyligen uppdaterat våra guider och handledningar. I denna artikel kommer vi att betona definitionen av Logto Management API, förklara hur det fungerar och visa typiska scenarier för att öka din produktivitet och frigöra fler användningsfall.
Vad är Logto Management API
Logto Management API är en kraftfull uppsättning av förbyggda API:er som ger utvecklare full kontroll för att anpassa sin implementering så att den passar deras produktbehov och teknikstack.
Det listas i API-resurslistan och kan inte raderas eller ändras. Allt du kan göra i Logto Admin Console kan också göras med Logto Management API.
Dess identifierare är i mönstret https://[tenant-id].logto.app/api
Det inkluderar all behörigheter som standard. När Logto växer kommer vi att fortsätta göra behörigheterna mer granulära.
Med Logto Management API kan du få tillgång till Logtos robusta backend-tjänster, som är mycket skalbara och kan användas i en mängd olika scenarier. För att lära dig om de API:er som är tillgängliga, besök Logto API-referenser.
Typiska scenarier för att använda management API
Våra utvecklare har implementerat många ytterligare funktioner med vårt Management API. Vi tror att vårt API är mycket skalbart och kan stödja en mängd olika behov. Här är några exempel på scenarier som inte är möjliga med Logto Admin Console men kan uppnås genom Management API.
Implementera användarprofil med ditt anpassade UI
Logto tillhandahåller för närvarande ingen förbyggd UI-lösning för användarprofiler. Vi inser att användarprofiler är nära knutna till affärs- och produktattribut. Medan vi arbetar med att bestämma den bästa metoden, föreslår vi att du använder våra API:er för att skapa din egen lösning. Till exempel kan du använda vårt interaktions-API, profil-API och verifieringskods-API för att utveckla en anpassad lösning som uppfyller dina behov. Vi har förberett en dedikerad sida User Profile för handledningar och guider.
Ett intressant exempel är att Logto Cloud-användarprofilfunktionen är byggd med hjälp av Logto Management API.
Implementera organisationshantering med ditt anpassade UI
Om du använder organisation-funktionen för att bygga din multi-tenant-app kan du behöva Logto management API för uppgifter som organisationsinbjudningar och medlemsadministration.
På liknande sätt är även Logto Cloud-inbjudnings- och samarbetsfunktionen byggd med hjälp av Logto Management API.
För att utöka det fallet, för din SaaS-produkt, där du har både administratörer och medlemmar i tenant, kan Logto management API hjälpa dig att skapa en anpassad administratörsportal som är utformad efter dina affärsbehov. Kolla in detta för mer detaljer.
Avancerad användarssökning
Logto Admin Console stöder grundläggande sök- och filtreringsfunktioner. Om du behöver mer avancerade alternativ för att skräddarsy din användarhanteringstjänst efter dina affärsbehov kan du använda Logto Management API. Det stöder avancerade sökalternativ, såsom:
- Fuzzy search
- Exact match
- Case sensitivity
- Specify fields
Kolla in våra Advanced User Search handledningar och guider.
Använd Logtos loggar för att konstruera dina egna tjänster
Logtos revisionslogg låter dig enkelt övervaka användaraktivitet och händelser. Det ger en stark grund för olika användarhantering och hälsoövervakningsscenarier.
Genom att använda management API kan du få tillgång till realtidsdata från revisionsloggen. Detta gör att du kan designa din egen schemamodell och instrumentpanel med hjälp av loggdata som erhålls från Logto.
Migrera och importera användare till Logto
Att använda Management API kan enkelt hjälpa dig att importera användardata, särskilt du vill göra en migration till Logto.
Efter att du förberett användardatan och ställt in password hashing och user schema, ställ in Management API-anslutningen och vi kommer att anropa create user API för att importera användardatan. För att lära dig mer om migrationen, kolla in detta dokument.
Hur man får tillgång till Logto Management API
Skapa en M2M-app
Välj M2M-apptyp och starta skapelseprocessen. Efter skapelsen blir du skickad till en modul där du kan tilldela en maskin-till-maskin-rol.
Efter att ha angett ett namn och en beskrivning ser du en modul som frågar dig att tilldela en roll. Denna modul inkluderar alla M2M-roller, roller som anges med en Logto-ikon innebär att dessa roller inkluderar Logto management API-behörigheter.
Tilldelning av M2M-roller inkluderar Logto management API-behörigheter för din M2M-app.
Varför använda maskin-till-maskin och tilldela maskin-till-maskin-roller?
Varför tillåter Logto M2M (Machine-to-Machine) kommunikation att anropa Logto Management API istället för att använda API-nycklar?
Logto hanterar kundidentitetshantering och följer strikt öppna standarder som OAuth 2.0 och OpenID Connect. M2M-token erbjuder säkra server-till-server-interaktioner med specifika omfattningar, vilket ger bättre säkerhet än statiska API-nycklar. Till skillnad från API-nycklar, som inte löper ut och innebär en högre risk om de äventyras, har M2M-token definierade utgångstider, vilket begränsar fönstret för potentiellt missbruk.
I Logto använder vi rollbaserad åtkomstkontroll (RBAC) för att skydda och hantera åtkomst till Logto Management API. Detta entitetsdiagram visar hur det fungerar.
Förhållandet mellan behörigheter, API-resurser, roller och maskin-till-maskin-applikation.
Hämta en åtkomsttoken
Grundläggande om åtkomsttoken-förfrågan
M2M-app gör en POST-förfrågan till token-slutpunkten för att hämta en åtkomsttoken genom att lägga till följande parametrar med hjälp av application/x-www-form-urlencoded-formatet i HTTP-förfrågans entitets-kropp:
- grant_type: måste ställas in till
client_credentials - resource: resursindikatorn du vill komma åt
- scope: Omfattningen av åtkomstförfrågan
Och du måste också inkludera dina M2M-referenser för token-slutpunkten för att autentisera din M2M-app. Detta uppnås genom att lägga till en Authorization-header med hjälp av Basic authentication, där användarnamn är App-ID och lösenord är App-hemligheten.
Du hittar App-ID och App-hemligheten från din M2M-applikations detaljsida:
Ett exempel på Logto Management API-åtkomsttoken-förfrågan är:
Hämta åtkomsttoken för Logto Management API
Logto tillhandahåller en inbyggd ”Logto Management API” resurs, det är en skrivskyddad resurs med all behörighet för att komma åt Logto Management API, du kan se den från din API-resurslista.
Resurs-API-indikatorn är i mönstret https://{YOUR_TENANT_ID}.logto.app/api, och detta kommer att vara ditt resursvärde som används i åtkomsttoken-förfrågans kropp.
Innan du får åtkomst till Logto Management API, se till att din M2M-app har tilldelats M2M-roller som inkluderar all behörighet från denna inbyggda ”Logto Management API” resurs.
Nu, sammanställ allt vi har och skicka förfrågan:
Token-svar
En lyckad svarskropp skulle se ut så här:
Få tillgång till Logto Manage API med hjälp av åtkomsttokenhttps://docs.logto.io/quick-starts/m2m/#access-resource-using-access-token
Du kanske märker att tokensvaret har ett token_type-fält, som är fastställt till Bearer. Därför bör du placera åtkomsttoken i Authorization-fältet i HTTP-headers med Bearer-formatet (Bearer YOUR_TOKEN).
Nu kan du få tillgång till Logto Management API genom att begära Logto Management API-slutpunkten https://[your-tenant-id].logto.app/api, för att få alla applikationer i Logto
Relaterade resurser
Här är några relaterade resurser som fördjupar våra tidigare insikter och strategier för att använda Logto Management API. Dessa material täcker olika aspekter, inklusive bästa praxis, implementeringstips och användningsfall, för att hjälpa dig att få ut det mesta av Logto Management API för dina projekt.