Share via

InteractiveBrowserCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra wewnątrz przeglądarki internetowej przy użyciu interaktywnego przepływu logowania.

Konstruktory

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Tworzy wystąpienie elementu InteractiveBrowserCredential z wymaganymi szczegółami.

To poświadczenie używa przepływu kodu autoryzacji. W Node.js zostanie otwarte okno przeglądarki podczas nasłuchiwania odpowiedzi przekierowania z usługi uwierzytelniania. W przeglądarkach uwierzytelnia się za pośrednictwem wyskakujących okienek. loginStyle Opcjonalny parametr można ustawić na wartość w celu redirect uwierzytelnienia, przekierowując użytkownika na stronę bezpiecznego logowania platformy Azure, która następnie przekierowuje użytkownika z powrotem do aplikacji internetowej, w której rozpoczęto uwierzytelnianie.

W przypadku Node.js, jeśli clientId zostanie podana, aplikacja Microsoft Entra musi być skonfigurowana tak, aby miała punkt końcowy przekierowania "Aplikacje mobilne i klasyczne". Postępuj zgodnie z naszym przewodnikiem dotyczącym konfigurowania identyfikatorów URI przekierowania dla aplikacji klasycznych wywołujących internetowe interfejsy API.

Metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli token nie można pobrać w trybie dyskretnym, ta metoda będzie wymagać interakcji użytkownika w celu pobrania tokenu.

W Node.js to poświadczenie ma domyślnie włączony klucz weryfikacji dla programu Code Exchange (PKCE). PKCE to funkcja zabezpieczeń, która ogranicza ataki przechwytywania kodu uwierzytelniania.
getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie można pobrać w trybie dyskretnym, ta metoda nie spróbuje zażądać interakcji użytkownika w celu pobrania tokenu.

Szczegóły konstruktora

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Tworzy wystąpienie elementu InteractiveBrowserCredential z wymaganymi szczegółami.

To poświadczenie używa przepływu kodu autoryzacji. W Node.js zostanie otwarte okno przeglądarki podczas nasłuchiwania odpowiedzi przekierowania z usługi uwierzytelniania. W przeglądarkach uwierzytelnia się za pośrednictwem wyskakujących okienek. loginStyle Opcjonalny parametr można ustawić na wartość w celu redirect uwierzytelnienia, przekierowując użytkownika na stronę bezpiecznego logowania platformy Azure, która następnie przekierowuje użytkownika z powrotem do aplikacji internetowej, w której rozpoczęto uwierzytelnianie.

W przypadku Node.js, jeśli clientId zostanie podana, aplikacja Microsoft Entra musi być skonfigurowana tak, aby miała punkt końcowy przekierowania "Aplikacje mobilne i klasyczne". Postępuj zgodnie z naszym przewodnikiem dotyczącym konfigurowania identyfikatorów URI przekierowania dla aplikacji klasycznych wywołujących internetowe interfejsy API.

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Parametry

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

Opcje konfigurowania klienta, który wysyła żądania uwierzytelniania.

Szczegóły metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli token nie można pobrać w trybie dyskretnym, ta metoda będzie wymagać interakcji użytkownika w celu pobrania tokenu.

W Node.js to poświadczenie ma domyślnie włączony klucz weryfikacji dla programu Code Exchange (PKCE). PKCE to funkcja zabezpieczeń, która ogranicza ataki przechwytywania kodu uwierzytelniania.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie można pobrać w trybie dyskretnym, ta metoda nie spróbuje zażądać interakcji użytkownika w celu pobrania tokenu.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<AccessToken>