Udostępnij za pośrednictwem


InteractiveBrowserCredential class

Umożliwia uwierzytelnianie w usłudze Microsoft Entra ID 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.jszostanie otwarte okno przeglądarki, gdy nasłuchuje odpowiedzi przekierowania z usługi uwierzytelniania. W przeglądarkach uwierzytelnia się za pośrednictwem wyskakujących okienek. Opcjonalny parametr loginStyle można ustawić na redirect do uwierzytelniania, przekierowując użytkownika do strony 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 zostanie podana clientId, aplikacja Microsoft Entra musi być skonfigurowana tak, aby miała punkt końcowy przekierowania "Aplikacje mobilne i klasyczne". Postępuj zgodnie z naszym przewodnikiem konfigurowania identyfikatorów URI przekierowania dla aplikacji klasycznych wywołujących internetowe interfejsy API.

Metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda zawsze wygeneruje wyzwanie dla użytkownika.

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

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania 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.jszostanie otwarte okno przeglądarki, gdy nasłuchuje odpowiedzi przekierowania z usługi uwierzytelniania. W przeglądarkach uwierzytelnia się za pośrednictwem wyskakujących okienek. Opcjonalny parametr loginStyle można ustawić na redirect do uwierzytelniania, przekierowując użytkownika do strony 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 zostanie podana clientId, aplikacja Microsoft Entra musi być skonfigurowana tak, aby miała punkt końcowy przekierowania "Aplikacje mobilne i klasyczne". Postępuj zgodnie z naszym przewodnikiem 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 identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda zawsze wygeneruje wyzwanie dla użytkownika.

W Node.jsto poświadczenie ma klucz dowodowy dla programu Code Exchange (PKCE) domyślnie włączony. 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 identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania 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>