InteractiveBrowserCredentialInBrowserOptions interface

Pakiet:

@azure/identity

Definiuje typowe opcje dla klasy InteractiveBrowserCredential.

Rozszerzenie

InteractiveCredentialOptions

Właściwości

clientId	Identyfikator klienta aplikacji Microsoft Entra, do którego użytkownicy będą się logować. Ten parametr jest wymagany w przeglądarce. Deweloperzy muszą zarejestrować swoje aplikacje i przypisać odpowiednie role. Aby uzyskać więcej informacji, odwiedź stronę https://aka.ms/identity/AppRegistrationAndRoleAssignment.
loginHint	loginHint umożliwia wstępne wybranie nazwy użytkownika na potrzeby logowania interakcyjnego. Ustawienie tej opcji pomija monit wyboru konta i natychmiast próbuje zalogować się przy użyciu określonego konta.
loginStyle	Określa, czy należy użyć przekierowania, czy okna podręcznego do zainicjowania przepływu uwierzytelniania użytkownika. Możliwe wartości to "redirect" lub "popup" (ustawienie domyślne) dla przeglądarki i "popup" (ustawienie domyślne) dla węzła.
redirectUri	Pobiera identyfikator URI przekierowania aplikacji. Ta wartość powinna być taka sama jak wartość w portalu rejestracji aplikacji. Wartość domyślna to window.location.href. To pole nie jest już wymagane dla Node.js.
tenantId	Identyfikator dzierżawy (katalogu) firmy Microsoft.

Właściwości dziedziczone

additionallyAllowedTenants	W przypadku aplikacji wielodostępnych określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy instalowanej przez aplikację.
additionalPolicies	Dodatkowe zasady do uwzględnienia w potoku HTTP.
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
authenticationRecord	Wynik poprzedniego uwierzytelniania, który może służyć do pobierania buforowanych poświadczeń poszczególnych kont. Jest to konieczne w przypadku, gdy aplikacja chce pracować z więcej niż jednym kontem na parę Identyfikator klienta i Identyfikator dzierżawy. Ten rekord można pobrać, wywołując metodę authenticate() poświadczeń w następujący sposób: const authenticationRecord = await credential.authenticate();
authorityHost	Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".
disableAutomaticAuthentication	Zgłasza wyjątek getToken, jeśli konieczne jest ręczne uwierzytelnianie. Deweloperzy będą musieli wywołać authenticate(), aby kontrolować, kiedy ręcznie się uwierzytelniać.
disableInstanceDiscovery	Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tej wartości na wartość true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub w usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ w celu zweryfikowania urzędu.
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
loggingOptions	Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i dane osobowe na potrzeby obsługi klienta.
proxyOptions	Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
retryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions	Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions	Opcje konfigurowania uwierzytelniania TLS
userAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

clientId

Identyfikator klienta aplikacji Microsoft Entra, do którego użytkownicy będą się logować. Ten parametr jest wymagany w przeglądarce. Deweloperzy muszą zarejestrować swoje aplikacje i przypisać odpowiednie role. Aby uzyskać więcej informacji, odwiedź stronę https://aka.ms/identity/AppRegistrationAndRoleAssignment.

clientId: string

Wartość właściwości

string

loginHint

loginHint umożliwia wstępne wybranie nazwy użytkownika na potrzeby logowania interakcyjnego. Ustawienie tej opcji pomija monit wyboru konta i natychmiast próbuje zalogować się przy użyciu określonego konta.

loginHint?: string

Wartość właściwości

string

loginStyle

Określa, czy należy użyć przekierowania, czy okna podręcznego do zainicjowania przepływu uwierzytelniania użytkownika. Możliwe wartości to "redirect" lub "popup" (ustawienie domyślne) dla przeglądarki i "popup" (ustawienie domyślne) dla węzła.

loginStyle?: BrowserLoginStyle

Wartość właściwości

BrowserLoginStyle

redirectUri

Pobiera identyfikator URI przekierowania aplikacji. Ta wartość powinna być taka sama jak wartość w portalu rejestracji aplikacji. Wartość domyślna to window.location.href. To pole nie jest już wymagane dla Node.js.

redirectUri?: string | () => string

Wartość właściwości

string | () => string

tenantId

Identyfikator dzierżawy (katalogu) firmy Microsoft.

tenantId?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

additionallyAllowedTenants

W przypadku aplikacji wielodostępnych określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy instalowanej przez aplikację.

additionallyAllowedTenants?: string[]

Wartość właściwości

string[]

dziedziczone zInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

dziedziczone zInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

dziedziczone zInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Wynik poprzedniego uwierzytelniania, który może służyć do pobierania buforowanych poświadczeń poszczególnych kont. Jest to konieczne w przypadku, gdy aplikacja chce pracować z więcej niż jednym kontem na parę Identyfikator klienta i Identyfikator dzierżawy.

Ten rekord można pobrać, wywołując metodę authenticate() poświadczeń w następujący sposób:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Wartość właściwości

AuthenticationRecord

dziedziczone zInteractiveCredentialOptions.authenticationRecord

authorityHost

Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".

authorityHost?: string

Wartość właściwości

string

dziedziczone zInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Zgłasza wyjątek getToken, jeśli konieczne jest ręczne uwierzytelnianie. Deweloperzy będą musieli wywołać authenticate(), aby kontrolować, kiedy ręcznie się uwierzytelniać.

disableAutomaticAuthentication?: boolean

Wartość właściwości

boolean

dziedziczone zInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tej wartości na wartość true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub w usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ w celu zweryfikowania urzędu.

disableInstanceDiscovery?: boolean

Wartość właściwości

boolean

dziedziczone zInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

dziedziczone zInteractiveCredentialOptions.httpClient

loggingOptions

Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i dane osobowe na potrzeby obsługi klienta.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Wartość właściwości

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

dziedziczone zInteractiveCredentialOptions.loggingOptions

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

dziedziczone zInteractiveCredentialOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

dziedziczone zInteractiveCredentialOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

dziedziczone zInteractiveCredentialOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

dziedziczone zInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

dziedziczone zInteractiveCredentialOptions.tlsOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

dziedziczone zInteractiveCredentialOptions.userAgentOptions