API-referenser och hantering av produktprofiler
Lär dig hur du hanterar autentiseringsuppgifter och produktprofil för OpenAPI-baserade AEM-API:er.
I den här självstudiekursen får du lära dig att lägga till eller ta bort:
- Autentiseringsuppgifter: Ange autentisering för ett AEM-API.
- Produktprofiler: Ange behörigheter (eller auktorisering) för autentiseringsuppgifter för åtkomst till AEM-resurserna.
Bakgrund
När du använder ett AEM-API måste du definiera autentiseringsuppgifter och produktprofil i Adobe Developer Console-projektet (eller ADC-projektet). På följande skärmbild kan du se Autentiseringsuppgifter och produktprofil för ett AEM Assets Author API:
Autentiseringsuppgifterna tillhandahåller autentiseringsmekanismen för API:t. Produktprofilen ger behörighet (eller behörighet) till autentiseringsuppgifterna och ger åtkomst till AEM-resurserna. API-begäran kan vara för ett program eller en användare.
En produktprofil är associerad med en eller flera tjänster. I AEM as a Cloud Service representerar en tjänst användargrupper med fördefinierade åtkomstkontrollistor (ACL) för databasnoder, vilket möjliggör detaljerad behörighetshantering.
När API-anropet lyckades skapas en användare som representerar ADC-projektets autentiseringsuppgifter i AEM Author-tjänsten tillsammans med användargrupperna som matchar produktprofilen och tjänstkonfigurationen.
I ovanstående scenario skapas användaren 1323d2... i AEM Author-tjänsten och är medlem i användargrupperna AEM Assets Collaborator Users - Service och AEM Assets Collaborator Users - author - Program XXX - Environment XXX.
Lägg till eller ta bort autentiseringsuppgifter
AEM API:er har stöd för följande typer av autentiseringsuppgifter:
- OAuth Server-till-server: Utformad för interaktioner mellan dator och dator.
- OAuth Web App: Utformad för användardrivna interaktioner med en serverdel i klientprogrammet.
- OAuth-app för en sida: Utformad för användardrivna interaktioner utan en serverdel i klientprogrammet.
Du kan använda olika användningsfall med olika typer av autentiseringsuppgifter.
Alla autentiseringsuppgifter hanteras i ADC-projektet.
Om du vill lägga till autentiseringsuppgifter för ett AEM API går du till avsnittet API:er i ADC-projektet och klickar på Anslut en annan autentiseringsuppgift. Följ sedan instruktionerna för den specifika autentiseringstypen.
Om du vill ta bort en AEM API-autentiseringsuppgift markerar du den i avsnittet API:er i ADC-projektet och klickar sedan på Ta bort autentiseringsuppgifter.
Lägg till eller ta bort produktprofiler
Produktprofilen ger behörighet (eller behörighet) till autentiseringsuppgifterna för åtkomst till AEM-resurserna. Behörigheterna som tillhandahålls av produktprofilen baseras på de tjänster som är kopplade till produktprofilen. De flesta tjänster ger behörighet READ till AEM-resurserna, via användargrupperna i AEM-instansen som har samma namn som tjänsten.
Det finns tillfällen när autentiseringsuppgifterna (även tekniska kontoanvändare) behöver ytterligare behörigheter, som Skapa, Uppdatera, Ta bort (CUD) för AEM-resurser. I sådana fall måste du lägga till en ny produktprofil som är associerad med tjänsterna som ger de behörigheter som krävs.
När ett anrop till AEM Assets Author API tar emot 403-fel för icke-GET-begäranden kan du till exempel lägga till AEM-administratörer - författare - Program XXX - Miljö XXX Produktprofil för att lösa problemet.
Om du vill lägga till produktprofiler för ett AEM API klickar du på Redigera produktprofiler i avsnittet API:er i ADC-projektet, väljer önskad produktprofil i dialogrutan Konfigurera API och sparar ändringarna.
Välj önskad produktprofil (t.ex. AEM-administratörer - författare - Program XXX - Miljö XXX) som är kopplad till de tjänster som krävs och spara sedan ändringarna.
Observera att produktprofilen AEM-administratörer - författare - program XXX - miljö XXX är kopplad till både AEM-administratörstjänsten och AEM Assets API-användartjänsten. Utan den senare kommer produktprofilen inte att visas i listan över tillgängliga produktprofiler.
PATCH-begäran om att uppdatera metadata för resursen bör nu fungera utan problem.
Om du vill ta bort produktprofiler för ett AEM API klickar du på Redigera produktprofiler i avsnittet API:er i ADC-projektet, avmarkerar önskad produktprofil i dialogrutan Konfigurera API och sparar ändringarna.
Sammanfattning
Du lärde dig att ändra autentiseringsmekanismen och behörigheterna för AEM API:er med Autentiseringsuppgifter och produktprofil i Adobe Developer Console-projektet (ADC).