Chiamare un'API in un'applicazione daemon Node.js di esempio
Questa guida usa un'applicazione daemon Node.js di esempio per mostrare come un'app daemon acquisisce un token di accesso per chiamare un'API Web.
Un'applicazione daemon acquisisce un token per conto di se stessa (non per conto di un utente). Gli utenti non possono interagire con un'applicazione daemon perché richiede la loro identità. Questo tipo di applicazione richiede un token di accesso usando la relativa identità applicazione e presentando l'ID applicazione, le credenziali (password o certificato) e l'URI dell’ID dell'applicazione all’ID esterno.
Un app daemon usa la concessione di credenziali client OAuth 2.0 standard. Per semplificare il processo di acquisizione del token, l'esempio usato in questo articolo usa Microsoft Authentication Library for Node (MSAL Node).
Prerequisiti
- Visual Studio Code o un altro editor di codice.
- Node.js.
- .NET 7.0 o versione successiva.
- Un tenant esterno. Per crearne uno, scegliere tra i metodi seguenti:
- (Scelta consigliata) Usare l'estensione Microsoft Entra per ID esterno per impostare un tenant esterno direttamente in Visual Studio Code.
- Creare un nuovo tenant esterno nell'interfaccia di amministrazione di Microsoft Entra.
Registrare un'applicazione daemon e un'API Web
In questo passaggio si creano le registrazioni dell'applicazione daemon e dell'API Web e si specificano gli ambiti dell'API Web.
Registrare un'applicazione API Web
Accedere all' Interfaccia di amministrazione di Microsoft Entra almeno come sviluppatore di applicazioni.
Se si ha accesso a più tenant, usare l'icona Impostazioni
nel menu in alto per passare al tenant esterno dal menu Directory e sottoscrizioni.
Passare a Identità>Applicazioni>Registrazioni app.
Seleziona + Nuova registrazione.
Nella pagina Registra un'applicazione visualizzata immettere le informazioni sulla registrazione dell'applicazione:
Nella sezione Nome immettere un nome significativo per l’applicazione che verrà visualizzato agli utenti dell'app, ad esempio ciam-ToDoList-api.
In Tipi di account supportati selezionare Account solo in questa directory organizzativa.
Selezionare Registra per creare l'applicazione.
Al termine della registrazione, viene visualizzato il riquadro Panoramica dell'applicazione. Registrare l'ID directory (tenant) e l'ID applicazione (client) da usare nel codice sorgente dell'applicazione.
Configurare i ruoli app
Un'API deve pubblicare almeno un ruolo app per le applicazioni, detto anche Autorizzazione dell'applicazione, affinché le app client possano ottenere autonomamente un token di accesso. Le autorizzazioni dell'applicazione sono il tipo di autorizzazioni che le API devono pubblicare quando vogliono consentire alle applicazioni client di eseguire correttamente l'autenticazione in modo autonomo, senza richiedere l'accesso degli utenti. Per pubblicare un'autorizzazione dell'applicazione, seguire questa procedura:
Nella pagina Registrazioni app, selezionare l'applicazione creata, ad esempio ciam-ToDoList-api, per aprire la relativa pagina Panoramica.
In Gestisci selezionare Ruoli app.
Selezionare Crea un ruolo app, quindi immettere i valori seguenti e selezionare Applica per salvare le modifiche:
Proprietà valore Nome visualizzato ToDoList.Read.All Tipi di membro consentiti Applicazioni Valore ToDoList.Read.All Descrizione Consentire all'app di leggere l’elenco di attività di ogni utente tramite "ToDoListApi" Selezionare di nuovo Crea un ruolo app, immettere i valori seguenti per il secondo ruolo dell'app, quindi selezionare Applica per salvare le modifiche:
Proprietà valore Nome visualizzato ToDoList.ReadWrite.All Tipi di membro consentiti Applicazioni Valore ToDoList.ReadWrite.All Descrizione Consente all'app di leggere e scrivere nell'elenco di attività di ogni utente tramite "ToDoListApi"
Configurare le attestazioni facoltative
È possibile usare l'attestazione facoltativa idtyp per aiutare l'API Web a determinare se un token è un token dell'app o un token dell'app e dell'utente. Sebbene sia possibile usare una combinazione di attestazioni scp e ruoli per lo stesso scopo, l'uso dell'attestazione idtyp è il modo più semplice per distinguere un token dell'app da un token dell'app e dell'utente. Ad esempio, il valore di questa attestazione è app quando il token è solo dell’app.
Registrare l'app daemon
Per abilitare l'applicazione all'accesso utente con Microsoft Entra, è necessario che Microsoft Entra per ID esterno riconosca l'applicazione creata. La registrazione dell'app stabilisce una relazione di trust tra l'app e Microsoft Entra. Quando si registra un'applicazione, l'ID esterno genera un identificatore univoco noto come ID applicazione (client), un valore usato per identificare l'app durante la creazione di richieste di autenticazione.
La procedura seguente spiega come registrare l'app nell'Interfaccia di amministrazione di Microsoft Entra:
Accedere all’Interfaccia di amministrazione di Microsoft Entra almeno come sviluppatore di applicazioni.
Se si ha accesso a più tenant, usare l'icona Impostazioni
nel menu in alto per passare al tenant esterno dal menu Directory e sottoscrizioni.
Passare a Identità>Applicazioni>Registrazioni app.
Seleziona + Nuova registrazione.
Nella pagina Registra un'applicazione che viene visualizzata:
- Immettere un nome significativo per l’applicazione da mostrare agli utenti dell'app, ad esempio ciam-client-app.
- In Tipi di account supportati selezionare Account solo in questa directory organizzativa.
Selezionare Registra.
Al termine della registrazione, viene visualizzato il riquadro Panoramica dell'applicazione. Registrare l'ID applicazione (client) da usare nel codice sorgente dell'applicazione.
Creare un segreto client
Creare un segreto client per l'applicazione registrata. L'applicazione usa il segreto client per dimostrare la propria identità quando richiede i token.
- Nella pagina Registrazioni app selezionare l'applicazione creata (ad esempio ciam-client-app) per aprire la relativa pagina Panoramica.
- In Gestisci, selezionare Certificati e segreti.
- Selezionare Nuovo segreto client.
- Nella casella Descrizione immettere una descrizione per il segreto client, (ad esempio, segreto client dell'app ciam).
- In Scadenzaselezionare la durata della validità del segreto (in base alle regole di sicurezza dell'organizzazione), quindi selezionare Aggiungi.
- Registrare il Valore del segreto. Questo valore verrà usato per la configurazione in un passaggio successivo. Il valore del segreto non verrà visualizzato di nuovo e non sarà recuperabile in alcun modo una volta usciti da Certificati e segreti. Accertarsi di registrarlo.
Concedere autorizzazioni API all'app daemon
Nella pagina Registrazioni app selezionare l'applicazione creata, ad esempio ciam-client-app.
In Gestisci selezionare Autorizzazioni API.
In Autorizzazioni configurate selezionare Aggiungi un'autorizzazione.
Selezionare la scheda API usate dall'organizzazione.
Nell'elenco delle API, selezionare l'API, ad esempio ciam-ToDoList-api.
Selezionare l’opzione Autorizzazioni applicazione. Questa opzione viene selezionata poiché l'applicazione effettua l'accesso autonomamente, senza agire per conto di un utente.
Nell'elenco delle autorizzazioni selezionare TodoList.Read.All, ToDoList.ReadWrite.All (usare la casella di ricerca, se necessario).
Selezionare il pulsante Aggiungi autorizzazioni.
A questo punto, le autorizzazioni sono state assegnate correttamente. Tuttavia, poiché l'app daemon non consente agli utenti di interagire con essa, questi non possono fornire il consenso a queste autorizzazioni. Per risolvere questo problema, l'amministratore deve fornire il consenso a queste autorizzazioni per conto di tutti gli utenti nel tenant:
- Selezionare Concedi consenso amministratore per <nome del tenant>, quindi selezionare Sì.
- Selezionare Aggiorna, quindi verificare che il valore di Concesso per <nome del tenant> venga visualizzato in Stato per entrambe le autorizzazioni.
Clonare o scaricare un'applicazione daemon di esempio e un'API Web
Per ottenere l'applicazione di esempio, è possibile clonarla da GitHub o scaricarla come file .zip.
Per clonare l'esempio, aprire un prompt dei comandi, passare alla posizione in cui si vuole creare il progetto e immettere il comando seguente:
git clone https://github.com/Azure-Samples/ms-identity-ciam-javascript-tutorial.git
In alternativa, scaricare il file .zip di esempio ed estrarlo in un percorso di file in cui la lunghezza del nome è inferiore a 260 caratteri.
Installare le dipendenze del progetto
Aprire una finestra della console e passare alla directory contenente l'app Node.js di esempio:
cd 2-Authorization\3-call-api-node-daemon\App
Eseguire i comandi seguenti per installare le dipendenze dell'app:
npm install && npm update
Configurare l'app daemon di esempio e l'API
Per usare la registrazione dell'app nell’app Web client di esempio:
Nell'editor di codice, aprire il file
App\authConfig.js
.Trovare il segnaposto:
Enter_the_Application_Id_Here
e sostituirlo con l'ID applicazione (client) dell’app registrato in precedenza.Enter_the_Tenant_Subdomain_Here
e sostituirlo con il sottodominio della directory (tenant). Ad esempio, se il dominio primario del tenant ècontoso.onmicrosoft.com
, usarecontoso
. Se non si dispone del nome del tenant, scoprire come leggere i dettagli del tenant.Enter_the_Client_Secret_Here
e sostituirlo con il valore del segreto dell'app copiato in precedenza.Enter_the_Web_Api_Application_Id_Here
e sostituirlo con l'ID applicazione (client) dell'API Web copiata in precedenza.
Per usare la registrazione dell'app nell'esempio di API Web:
Nell'editor di codice, aprire il file
API\ToDoListAPI\appsettings.json
.Trovare il segnaposto:
Enter_the_Application_Id_Here
e sostituirlo con l'ID applicazione (client) dell'API Web copiata.Enter_the_Tenant_Id_Here
e sostituirlo con l'ID directory (tenant) copiato in precedenza.Enter_the_Tenant_Subdomain_Here
e sostituirlo con il sottodominio della directory (tenant). Ad esempio, se il dominio primario del tenant ècontoso.onmicrosoft.com
, usarecontoso
. Se non si dispone del nome del tenant, scoprire come leggere i dettagli del tenant.
Eseguire e testare l'app daemon di esempio e l'API
Aprire una finestra della console, quindi eseguire l'API Web usando i comandi seguenti:
cd 2-Authorization\3-call-api-node-daemon\API\ToDoListAPI dotnet run
Eseguire il client dell'app Web usando i comandi seguenti:
2-Authorization\3-call-api-node-daemon\App node . --op getToDos
Se l'applicazione daemon e l'API Web vengono eseguite correttamente, in genere la finestra della console ha un aspetto simile alla matrice JSON seguente.
{ "id": 1, "owner": "3e8....-db63-43a2-a767-5d7db...", "description": "Pick up grocery" }, { "id": 2, "owner": "c3cc....-c4ec-4531-a197-cb919ed.....", "description": "Finish invoice report" }, { "id": 3, "owner": "a35e....-3b8a-4632-8c4f-ffb840d.....", "description": "Water plants" }
Funzionamento
L'app Node.js usa la concessione di credenziali client OAuth 2.0 per acquisire un token di accesso per se stessa e non per conto dell'utente. Token di accesso richiesto dall'app contenente le autorizzazioni rappresentate come ruoli. Il flusso delle credenziali client usa questo set di autorizzazioni anziché gli ambiti utente per i token dell'applicazione. Queste autorizzazioni dell'applicazione sono state esposte in precedenza nell'API Web, quindi sono state concesse all'app daemon.
Sul lato API l'API Web deve verificare che il token di accesso disponga delle autorizzazioni necessarie (autorizzazioni dell'applicazione). L'API Web non può accettare un token di accesso che non dispone delle autorizzazioni necessarie.
Accesso ai dati
Un endpoint API Web deve essere preparato ad accettare chiamate da utenti e applicazioni. Pertanto, deve avere un modo per rispondere a ogni richiesta in modo appropriato. Ad esempio, una chiamata da un utente tramite autorizzazioni/ambiti delegati riceve l'elenco attività dei dati dell'utente. D'altra parte, una chiamata da un'applicazione tramite autorizzazioni/ruoli dell'applicazione può ricevere l'intero elenco attività. Tuttavia, in questo articolo viene eseguita solo una chiamata all'applicazione, quindi non è necessario configurare autorizzazioni/ambiti delegati.