Freigeben über

DeviceCodeCredential class

  • Referenz
Paket:
@azure/identity

Ermöglicht die Authentifizierung für Microsoft Entra-ID mithilfe eines Gerätecodes, den der Benutzer in https://microsoft.com/devicelogineingeben kann.

Konstruktoren

DeviceCodeCredential(DeviceCodeCredentialOptions)

Erstellt eine Instanz von DeviceCodeCredential mit den Details, die zum Initiieren des Gerätecode-Autorisierungsflusses mit Microsoft Entra ID erforderlich sind.

Eine Nachricht wird protokolliert, sodass Benutzer einen Code erhalten, den sie für die Authentifizierung verwenden können, sobald sie zu https://microsoft.com/devicelogin

Entwickler können konfigurieren, wie diese Meldung angezeigt wird, indem sie eine benutzerdefinierte userPromptCallbackübergeben:

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);
  },
});

Methoden

authenticate(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn das Token nicht im Hintergrund abgerufen werden kann, generiert diese Methode immer eine Herausforderung für den Benutzer.
getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn der Benutzer die Option disableAutomaticAuthenticationbereitgestellt hat, wird diese Methode nicht versucht, die Benutzerinteraktion zum Abrufen des Tokens anzufordern, sobald das Token nicht im Hintergrund abgerufen werden kann.

Details zum Konstruktor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Erstellt eine Instanz von DeviceCodeCredential mit den Details, die zum Initiieren des Gerätecode-Autorisierungsflusses mit Microsoft Entra ID erforderlich sind.

Eine Nachricht wird protokolliert, sodass Benutzer einen Code erhalten, den sie für die Authentifizierung verwenden können, sobald sie zu https://microsoft.com/devicelogin

Entwickler können konfigurieren, wie diese Meldung angezeigt wird, indem sie eine benutzerdefinierte userPromptCallbackübergeben:

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)

Parameter

options
DeviceCodeCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderungen vorgibt.

Details zur Methode

authenticate(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn das Token nicht im Hintergrund abgerufen werden kann, generiert diese Methode immer eine Herausforderung für den Benutzer.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, für die das Token Zugriff hat.

options
GetTokenOptions

Die Optionen zum Konfigurieren von Anforderungen, die diese TokenCredential-Implementierung möglicherweise vorgibt.

Gibt zurück

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn der Benutzer die Option disableAutomaticAuthenticationbereitgestellt hat, wird diese Methode nicht versucht, die Benutzerinteraktion zum Abrufen des Tokens anzufordern, sobald das Token nicht im Hintergrund abgerufen werden kann.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, für die das Token Zugriff hat.

options
GetTokenOptions

Die Optionen zum Konfigurieren von Anforderungen, die diese TokenCredential-Implementierung möglicherweise vorgibt.

Gibt zurück

Promise<AccessToken>