Condividi tramite

AuthorizationCodeCredential class

  • Riferimento
Pacchetto:
@azure/identity

Consente l'autenticazione per Microsoft Entra ID usando un codice di autorizzazione ottenuto tramite il flusso del codice di autorizzazione, descritto in modo più dettagliato nella documentazione di Microsoft Entra ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Costruttori

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Crea un'istanza di AuthorizationCodeCredential con i dettagli necessari per richiedere un token di accesso usando un'autenticazione ottenuta da Microsoft Entra ID.

È attualmente necessario per l'utente di questa credenziale avviare il flusso del codice di autorizzazione per ottenere un codice di autorizzazione da usare con questa credenziale. Di seguito è riportato un esempio completo di questo flusso:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Crea un'istanza di AuthorizationCodeCredential con i dettagli necessari per richiedere un token di accesso usando un'autenticazione ottenuta da Microsoft Entra ID.

È attualmente necessario per l'utente di questa credenziale avviare il flusso del codice di autorizzazione per ottenere un codice di autorizzazione da usare con questa credenziale. Di seguito è riportato un esempio completo di questo flusso:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

Metodi

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata un'eccezione CredentialUnavailableError con i dettagli dell'errore.

Dettagli costruttore

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Crea un'istanza di AuthorizationCodeCredential con i dettagli necessari per richiedere un token di accesso usando un'autenticazione ottenuta da Microsoft Entra ID.

È attualmente necessario per l'utente di questa credenziale avviare il flusso del codice di autorizzazione per ottenere un codice di autorizzazione da usare con questa credenziale. Di seguito è riportato un esempio completo di questo flusso:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametri

tenantId

string

ID o nome del tenant (directory) del Microsoft Entra. È possibile usare "common" quando si gestiscono scenari multi-tenant.

clientId

string

ID client (applicazione) di una registrazione dell'app nel tenant.

authorizationCode

string

Codice di autorizzazione ricevuto dopo il flusso del codice di autorizzazione. Questo codice di autorizzazione non deve essere già stato usato per ottenere un token di accesso.

redirectUri

string

URI di reindirizzamento usato per richiedere il codice di autorizzazione. Deve essere lo stesso URI configurato per la registrazione dell'app.

options
AuthorizationCodeCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta del token di accesso.

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Crea un'istanza di AuthorizationCodeCredential con i dettagli necessari per richiedere un token di accesso usando un'autenticazione ottenuta da Microsoft Entra ID.

È attualmente necessario per l'utente di questa credenziale avviare il flusso del codice di autorizzazione per ottenere un codice di autorizzazione da usare con questa credenziale. Di seguito è riportato un esempio completo di questo flusso:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametri

tenantId

string

ID o nome del tenant (directory) del Microsoft Entra. È possibile usare "common" quando si gestiscono scenari multi-tenant.

clientId

string

ID client (applicazione) di una registrazione dell'app nel tenant.

clientSecret

string

Segreto client generato per la registrazione dell'app

authorizationCode

string

Codice di autorizzazione ricevuto dopo il flusso del codice di autorizzazione. Questo codice di autorizzazione non deve essere già stato usato per ottenere un token di accesso.

redirectUri

string

URI di reindirizzamento usato per richiedere il codice di autorizzazione. Deve essere lo stesso URI configurato per la registrazione dell'app.

options
AuthorizationCodeCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta del token di accesso.

Dettagli metodo

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata un'eccezione CredentialUnavailableError con i dettagli dell'errore.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parametri

scopes

string | string[]

Elenco di ambiti a cui il token avrà accesso.

options
GetTokenOptions

Le opzioni usate per configurare le richieste che potrebbero essere eseguite da questa implementazione di TokenCredential.

Restituisce

Promise<AccessToken>