Gestione delle credenziali API e del profilo di prodotto
Scopri come gestire Credenziali e profilo di prodotto per le API AEM basate su OpenAPI.
Questa esercitazione spiega come aggiungere o rimuovere:
- Credenziali: fornire l'autenticazione per un'API AEM.
- Profili di prodotto: fornisci le autorizzazioni (o autorizzazioni) per le credenziali di accesso alle risorse di AEM.
Informazioni di base
Quando utilizzi un'API di AEM, devi definire le credenziali e il profilo di prodotto nel progetto Adobe Developer Console (o ADC). Nella schermata seguente puoi visualizzare le credenziali e il profilo di prodotto per un'API di authoring AEM Assets:
Le credenziali forniscono il meccanismo di autenticazione per l'API. Il profilo prodotto concede autorizzazioni (o autorizzazione) alle credenziali, fornendo l'accesso alle risorse di AEM. La richiesta API potrebbe essere per conto di un’applicazione o di un utente.
Un profilo di prodotto è associato a uno o più Servizi. In AEM as a Cloud Service, un servizio rappresenta gruppi di utenti con elenchi di controllo di accesso (ACL) predefiniti per i nodi dell'archivio, consentendo la gestione granulare delle autorizzazioni.
Dopo aver chiamato correttamente l’API, viene creato nel servizio AEM Author un utente che rappresenta le credenziali del progetto ADC, insieme ai gruppi di utenti che corrispondono alla configurazione del profilo di prodotto e dei servizi.
Nello scenario precedente, l'utente 1323d2... viene creato nel servizio AEM Author ed è membro dei gruppi di utenti AEM Assets Collaborator Users - Service e AEM Assets Collaborator Users - author - Program XXX - Environment XXX.
Aggiungi o rimuovi credenziali
Le API di AEM supportano i seguenti tipi di credenziali per l’autenticazione:
- OAuth Server-to-Server: progettato per le interazioni da macchina a macchina.
- App Web OAuth: progettata per le interazioni guidate dall'utente con un server back-end nell'applicazione client.
- App a pagina singola OAuth: progettata per interazioni guidate dall'utente senza un server back-end nell'applicazione client.
Puoi supportare diversi casi d’uso utilizzando diversi tipi di credenziali.
Tutte le credenziali vengono gestite nel progetto ADC.
Per aggiungere le credenziali per un'API AEM, vai alla sezione API del progetto ADC e fai clic su Connetti un'altra credenziale. Quindi, seguire le istruzioni per il tipo di credenziale specifico.
Per rimuovere le credenziali API di AEM, selezionarle nella sezione API del progetto ADC, quindi fare clic su Elimina credenziali.
Aggiungere o rimuovere profili di prodotto
Il profilo prodotto fornisce le autorizzazioni (o autorizzazione) alle credenziali per accedere alle risorse AEM. Le autorizzazioni fornite dal profilo prodotto si basano sui servizi associati al profilo prodotto. La maggior parte dei Servizi fornisce l'autorizzazione READ alle risorse AEM tramite i gruppi di utenti nell'istanza AEM che hanno lo stesso nome del Servizio.
In alcuni casi le credenziali (ovvero l'utente dell'account tecnico) richiedono autorizzazioni aggiuntive, ad esempio Crea, Aggiorna, Elimina (CUD) delle risorse AEM. In questi casi, è necessario aggiungere un nuovo Profilo prodotto associato ai Servizi che forniscono le autorizzazioni necessarie.
Ad esempio, quando la chiamata API di AEM Assets Author riceve l'errore 403 per richieste non GET, puoi aggiungere Amministratori AEM - Autore - Programma XXX - Ambiente XXX Profilo prodotto per risolvere il problema.
Per aggiungere profili di prodotto per un'API AEM, fai clic su Modifica profili di prodotto nella sezione API del progetto ADC, seleziona il profilo di prodotto desiderato nella finestra di dialogo Configura API e salva le modifiche.
Seleziona il profilo di prodotto desiderato (ad esempio, Amministratori AEM - Autore - Programma XXX - Ambiente XXX) associato ai servizi richiesti, quindi salva le modifiche.
Il profilo di prodotto Amministratori AEM - Autore - Programma XXX - Ambiente XXX è associato sia al servizio Amministratori AEM che al servizio Utenti API AEM Assets. In assenza di quest’ultimo, il profilo di prodotto non verrà visualizzato nell’elenco dei profili di prodotto disponibili.
La richiesta di PATCH per aggiornare i metadati della risorsa ora dovrebbe funzionare senza problemi.
Per rimuovere i profili di prodotto per un'API di AEM, fai clic su Modifica profili di prodotto nella sezione API del progetto ADC, deseleziona il profilo di prodotto desiderato nella finestra di dialogo Configura API e salva le modifiche.
Riepilogo
Hai imparato a modificare il meccanismo di autenticazione e le autorizzazioni per le API di AEM utilizzando Credenziali e profilo di prodotto nel progetto Adobe Developer Console (ADC).