Freigeben über

InteractiveBrowserCredential class

  • Referenz
Paket:
@azure/identity

Ermöglicht die Authentifizierung zum Microsoft Entra ID innerhalb des Webbrowsers mithilfe des interaktiven Anmeldeflows.

Konstruktoren

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Erstellt eine instance von InteractiveBrowserCredential mit den erforderlichen Details.

Diese Anmeldeinformationen verwenden den Autorisierungscodeflow. Auf Node.js wird ein Browserfenster geöffnet, während eine Umleitungsantwort vom Authentifizierungsdienst überwacht wird. In Browsern wird die Authentifizierung über Popups durchgeführt. Der loginStyle optionale Parameter kann auf redirect festgelegt werden, um sich zu authentifizieren, indem der Benutzer zu einer Sicheren Azure-Anmeldeseite umgeleitet wird, die den Benutzer dann zurück zu der Webanwendung umleitet, in der die Authentifizierung gestartet wurde.

Wenn Node.js clientId bereitgestellt wird, muss die Microsoft Entra Anwendung so konfiguriert werden, dass sie über einen Umleitungsendpunkt "Mobile und Desktopanwendungen" verfügt. Befolgen Sie unsere Anleitung zum Einrichten von Umleitungs-URIs für Desktop-Apps, die Web-APIs aufrufen.

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 im Hintergrund abgerufen werden kann, erfordert diese Methode eine Benutzerinteraktion, um das Token abzurufen.

Auf Node.js ist für diese Anmeldeinformationen standardmäßig Proof Key for Code Exchange (PKCE) aktiviert. PKCE ist ein Sicherheitsfeature, das Authentifizierungscode-Abfangangriffe entschärft.
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 disableAutomaticAuthenticationbereitgestellt hat, sobald das Token nicht im Hintergrund abgerufen werden kann, versucht diese Methode nicht, eine Benutzerinteraktion anzufordern, um das Token abzurufen.

Details zum Konstruktor

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Erstellt eine instance von InteractiveBrowserCredential mit den erforderlichen Details.

Diese Anmeldeinformationen verwenden den Autorisierungscodeflow. Auf Node.js wird ein Browserfenster geöffnet, während eine Umleitungsantwort vom Authentifizierungsdienst überwacht wird. In Browsern wird die Authentifizierung über Popups durchgeführt. Der loginStyle optionale Parameter kann auf redirect festgelegt werden, um sich zu authentifizieren, indem der Benutzer zu einer Sicheren Azure-Anmeldeseite umgeleitet wird, die den Benutzer dann zurück zu der Webanwendung umleitet, in der die Authentifizierung gestartet wurde.

Wenn Node.js clientId bereitgestellt wird, muss die Microsoft Entra Anwendung so konfiguriert werden, dass sie über einen Umleitungsendpunkt "Mobile und Desktopanwendungen" verfügt. Befolgen Sie unsere Anleitung zum Einrichten von Umleitungs-URIs für Desktop-Apps, die Web-APIs aufrufen.

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Parameter

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

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 im Hintergrund abgerufen werden kann, erfordert diese Methode eine Benutzerinteraktion, um das Token abzurufen.

Auf Node.js ist für diese Anmeldeinformationen standardmäßig Proof Key for Code Exchange (PKCE) aktiviert. PKCE ist ein Sicherheitsfeature, das Authentifizierungscode-Abfangangriffe entschärft.

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 diese TokenCredential-Implementierung möglicherweise stellt.

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 disableAutomaticAuthenticationbereitgestellt hat, sobald das Token nicht im Hintergrund abgerufen werden kann, versucht diese Methode nicht, eine Benutzerinteraktion anzufordern, um das Token abzurufen.

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 diese TokenCredential-Implementierung möglicherweise stellt.

Gibt zurück

Promise<AccessToken>