Condividi tramite

DeviceCodeCredential class

  • Riferimento
Pacchetto:
@azure/identity

Abilita l'autenticazione a Microsoft Entra ID usando un codice del dispositivo che l'utente può immettere in https://microsoft.com/devicelogin.

Costruttori

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crea un'istanza di DeviceCodeCredential con i dettagli necessari per avviare il flusso di autorizzazione del codice del dispositivo con Microsoft Entra ID.

Verrà registrato un messaggio, fornendo agli utenti un codice che può usare per eseguire l'autenticazione quando passano a https://microsoft.com/devicelogin

Gli sviluppatori possono configurare la modalità di visualizzazione di questo messaggio passando un userPromptCallbackpersonalizzato:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

Metodi

authenticate(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 una CredentialUnavailableError con i dettagli dell'errore.

Se il token non può essere recuperato automaticamente, questo metodo genererà sempre una richiesta per l'utente.
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 una CredentialUnavailableError con i dettagli dell'errore.

Se l'utente ha fornito l'opzione disableAutomaticAuthentication, una volta che il token non può essere recuperato automaticamente, questo metodo non tenterà di richiedere l'interazione dell'utente per recuperare il token.

Dettagli costruttore

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crea un'istanza di DeviceCodeCredential con i dettagli necessari per avviare il flusso di autorizzazione del codice del dispositivo con Microsoft Entra ID.

Verrà registrato un messaggio, fornendo agli utenti un codice che può usare per eseguire l'autenticazione quando passano a https://microsoft.com/devicelogin

Gli sviluppatori possono configurare la modalità di visualizzazione di questo messaggio passando un userPromptCallbackpersonalizzato:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

Parametri

options
DeviceCodeCredentialOptions

Opzioni per la configurazione del client che effettua le richieste di autenticazione.

Dettagli metodo

authenticate(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 una CredentialUnavailableError con i dettagli dell'errore.

Se il token non può essere recuperato automaticamente, questo metodo genererà sempre una richiesta per l'utente.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

Parametri

scopes

string | string[]

Elenco di ambiti per i quali il token avrà accesso.

options
GetTokenOptions

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

Restituisce

Promise<undefined | AuthenticationRecord>

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 una CredentialUnavailableError con i dettagli dell'errore.

Se l'utente ha fornito l'opzione disableAutomaticAuthentication, una volta che il token non può essere recuperato automaticamente, questo metodo non tenterà di richiedere l'interazione dell'utente per recuperare il token.

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

Parametri

scopes

string | string[]

Elenco di ambiti per i quali 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>