Freigeben über

DeviceCodeCredential class

  • Referenz
Paket:
@azure/identity

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines Gerätecodes, den der Benutzer eingeben https://microsoft.com/deviceloginkann.

Konstruktoren

DeviceCodeCredential(DeviceCodeCredentialOptions)

Erstellt eine instance von DeviceCodeCredential mit den Details, die zum Initiieren des Gerätecodeautorisierungsflows mit Microsoft Entra ID erforderlich sind.

Es wird eine Nachricht protokolliert, in der Benutzer einen Code erhalten, den sie zum Authentifizieren verwenden können, sobald sie zu wechseln. https://microsoft.com/devicelogin

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

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

Methoden

authenticate(string | string[], GetTokenOptions)

Authentifiziert sich mit 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 unbeaufsichtigt abgerufen werden kann, erfordert diese Methode eine Benutzerinteraktion, um das Token abzurufen.
getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit 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 disableAutomaticAuthenticationangegeben hat, versucht diese Methode nicht, eine Benutzerinteraktion anzufordern, um das Token abzurufen, sobald das Token nicht automatisch abgerufen werden kann.

Details zum Konstruktor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Erstellt eine instance von DeviceCodeCredential mit den Details, die zum Initiieren des Gerätecodeautorisierungsflows mit Microsoft Entra ID erforderlich sind.

Es wird eine Nachricht protokolliert, in der Benutzer einen Code erhalten, den sie zum Authentifizieren verwenden können, sobald sie zu wechseln. https://microsoft.com/devicelogin

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

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: 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 stellt.

Details zur Methode

authenticate(string | string[], GetTokenOptions)

Authentifiziert sich mit 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 unbeaufsichtigt abgerufen werden kann, erfordert diese Methode eine Benutzerinteraktion, um das Token abzurufen.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, auf die das Token Zugriff hat.

options
GetTokenOptions

Die Optionen, die zum Konfigurieren von Anforderungen verwendet werden, die von dieser TokenCredential-Implementierung möglicherweise vorgenommen werden.

Gibt zurück

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit 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 disableAutomaticAuthenticationangegeben hat, versucht diese Methode nicht, eine Benutzerinteraktion anzufordern, um das Token abzurufen, sobald das Token nicht automatisch abgerufen werden kann.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, auf die das Token Zugriff hat.

options
GetTokenOptions

Die Optionen, die zum Konfigurieren von Anforderungen verwendet werden, die von dieser TokenCredential-Implementierung möglicherweise vorgenommen werden.

Gibt zurück

Promise<AccessToken>