InteractiveBrowserCredentialBuilder Klasse

Paket:

com.azure.identity

Maven-Artefakt:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>
  • • com.azure.identity.AadCredentialBuilderBase<T>
    • • com.azure.identity.InteractiveBrowserCredentialBuilder

public class InteractiveBrowserCredentialBuilder
extends AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

Fluent-Anmeldeinformationsgenerator zum Instanziieren von InteractiveBrowserCredential.

Die interaktive Browserauthentifizierung ist eine Art von Authentifizierungsfluss, der von Azure Active Directory (Azure AD) angeboten wird und es Benutzern ermöglicht, sich mit einem Webbrowser bei Anwendungen und Diensten anzumelden. Diese Authentifizierungsmethode wird häufig für Webanwendungen verwendet, bei denen Benutzer ihre Anmeldeinformationen direkt in eine Webseite eingeben. Bei der interaktiven Browserauthentifizierung navigiert der Benutzer zu einer Webanwendung und wird aufgefordert, seine Anmeldeinformationen für Benutzername und Kennwort einzugeben. Die Anwendung leitet den Benutzer dann zur Azure AD-Anmeldeseite um, wo er aufgefordert wird, seine Anmeldeinformationen erneut einzugeben. Nachdem sich der Benutzer erfolgreich authentifiziert hat, gibt Azure AD ein Sicherheitstoken aus, mit dem die Anwendung den Zugriff des Benutzers auf seine Ressourcen autorisieren kann. Der InteractiveBrowserCredential authentifiziert einen Benutzer interaktiv und ruft ein Token mit dem Standardsystembrowser ab und bietet eine reibungslose Authentifizierung, indem ein Benutzer seine eigenen Anmeldeinformationen zur Authentifizierung der Anwendung verwenden lässt. Bei der Authentifizierung benachrichtigt der oauth2-Flow die Anmeldeinformationen des Authentifizierungscodes über die Antwort-URL. Weitere Informationen finden Sie in den konzeptionellen Kenntnissen und Konfigurationsdetails.

Beispiel: Construct InteractiveBrowserCredential

Im folgenden Codebeispiel wird die Erstellung eines InteractiveBrowserCredentialveranschaulicht, wobei verwendet wird, InteractiveBrowserCredentialBuilder um ihn zu konfigurieren. Standardmäßig zielen die Anmeldeinformationen auf eine localhost-Umleitungs-URL ab, um dieses Verhalten zu überschreiben, redirectUrl(String redirectUrl) das optional angegeben werden kann. Nachdem diese Anmeldeinformationen erstellt wurden, können sie als Parameter "credential" an den Generator vieler Client-Generatoren des Azure SDK für Java übergeben werden.

TokenCredential interactiveBrowserCredential = new InteractiveBrowserCredentialBuilder()
     .redirectUrl("http://localhost:8765")
     .build();

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
InteractiveBrowserCredentialBuilder()

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
InteractiveBrowserCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können.
InteractiveBrowserCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können.
InteractiveBrowserCredentialBuilder	authenticationRecord(AuthenticationRecord authenticationRecord) Legt die AuthenticationRecord aus einer vorherigen Authentifizierung erfasste fest.
InteractiveBrowserCredentialBuilder	browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions) Konfiguriert die Optionen zum Anpassen des Browsers für die interaktive Authentifizierung.
InteractiveBrowserCredential	build() Erstellt eine neue InteractiveBrowserCredential mit den aktuellen Konfigurationen.
InteractiveBrowserCredentialBuilder	disableAutomaticAuthentication() Deaktiviert die automatische Authentifizierung und verhindert, dass der InteractiveBrowserCredential Benutzer automatisch aufgefordert wird.
InteractiveBrowserCredentialBuilder	loginHint(String loginHint) Legt den Benutzernamensvorschlag so fest, dass das Feld Benutzername/E-Mail-Adresse der Anmeldeseite vorab ausgefüllt wird.
InteractiveBrowserCredentialBuilder	port(int port) Als veraltet markiert Konfigurieren Sie die Umleitungs-URL stattdessen als http://localhost:{port} über redirectUrl(String redirectUrl) . Legt den Port für den lokalen HTTP-Server fest, für den http://localhost:{port} als gültige Antwort-URL für die Anwendung registriert werden muss.
InteractiveBrowserCredentialBuilder	redirectUrl(String redirectUrl) Legt die Umleitungs-URL fest, in der STS die Anwendung mit dem Sicherheitscode zurückruft.
InteractiveBrowserCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Konfiguriert die Optionen für den Cache für persistente freigegebene Token und aktiviert den standardmäßig deaktivierten Cache für persistente Token.

Geerbte Methoden von AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Geerbte Methoden von CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

InteractiveBrowserCredentialBuilder

public InteractiveBrowserCredentialBuilder()

Details zur Methode

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, auf dem die Anwendung installiert ist. Wenn kein Wert für TenantId angegeben wird, hat diese Option keine Auswirkungen, und die Anmeldeinformationen erhalten Token für jeden angeforderten Mandanten.

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - die zusätzlich zulässigen Mandanten.

Returns:

Eine aktualisierte instance dieses Generators mit den konfigurierten zusätzlichen Mandanten.

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, auf dem die Anwendung installiert ist. Wenn kein Wert für TenantId angegeben wird, hat diese Option keine Auswirkungen, und die Anmeldeinformationen erhalten Token für jeden angeforderten Mandanten.

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - die zusätzlich zulässigen Mandanten.

Returns:

Eine aktualisierte instance dieses Generators mit den konfigurierten zusätzlichen Mandanten.

authenticationRecord

public InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

Legt die AuthenticationRecord aus einer vorherigen Authentifizierung erfasste fest.

Parameters:

authenticationRecord - Der zu konfigurierende Authentifizierungsdatensatz.

Returns:

Eine aktualisierte instance dieses Generators mit dem konfigurierten Authentifizierungsdatensatz.

browserCustomizationOptions

public InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

Konfiguriert die Optionen zum Anpassen des Browsers für die interaktive Authentifizierung.

Parameters:

browserCustomizationOptions - Browseranpassungsoptionen

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierten Browseranpassungsoptionen.

build

public InteractiveBrowserCredential build()

Erstellt eine neue InteractiveBrowserCredential mit den aktuellen Konfigurationen.

Returns:

a InteractiveBrowserCredential mit den aktuellen Konfigurationen.

disableAutomaticAuthentication

public InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()

Deaktiviert die automatische Authentifizierung und verhindert, dass der InteractiveBrowserCredential Benutzer automatisch aufgefordert wird. Wenn die automatische Authentifizierung deaktiviert ist, wird von AuthenticationRequiredExceptiongetToken(TokenRequestContext request) ausgelöst, falls eine Benutzerinteraktion erforderlich ist. Die Anwendung ist dafür verantwortlich, diese Ausnahme zu behandeln und den Benutzer interaktiv aufzurufen authenticate() oder authenticate(TokenRequestContext request) zu authentifizieren.

Returns:

Eine aktualisierte instance dieses Generators mit deaktivierter automatischer Authentifizierung.

loginHint

public InteractiveBrowserCredentialBuilder loginHint(String loginHint)

Legt den Benutzernamensvorschlag so fest, dass das Feld Benutzername/E-Mail-Adresse der Anmeldeseite vorab ausgefüllt wird. Ein Benutzer kann sich weiterhin mit einem anderen Benutzernamen anmelden.

Parameters:

loginHint - Der Benutzernamesvorschlag, um das Feld benutzername/E-Mail-Adresse der Anmeldeseite vorab auszufüllen.

Returns:

Ein aktualisierter instance dieses Generators mit konfiguriertem Anmeldehinweis.

port

@Deprecated
public InteractiveBrowserCredentialBuilder port(int port)

Als veraltet markiert

Konfigurieren Sie die Umleitungs-URL stattdessen als http://localhost:{port} über redirectUrl(String redirectUrl) .

Legt den Port für den lokalen HTTP-Server fest, für den http://localhost:{port} als gültige Antwort-URL für die Anwendung registriert werden muss.

Parameters:

port - Der Port, an dem die Anmeldeinformationen auf das Browserauthentifizierungsergebnis lauschen.

Returns:

InteractiveBrowserCredentialBuilder selbst

redirectUrl

public InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)

Legt die Umleitungs-URL fest, in der STS die Anwendung mit dem Sicherheitscode zurückruft. Dies ist erforderlich, wenn eine benutzerdefinierte Client-ID über InteractiveBrowserCredentialBuilder#clientId(String) angegeben wird und mit der während der Anwendungsregistrierung angegebenen Umleitungs-URL übereinstimmen muss.

Parameters:

redirectUrl - die Umleitungs-URL zum Lauschen und Empfangen von Sicherheitscode.

Returns:

Eine aktualisierte instance dieses Generators mit der konfigurierten Umleitungs-URL.

tokenCachePersistenceOptions

public InteractiveBrowserCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Konfiguriert die Optionen für den Cache für persistente freigegebene Token und aktiviert den standardmäßig deaktivierten Cache für persistente Token. Wenn sie konfiguriert sind, speichern die Anmeldeinformationen Token in einem Auf dem Computer gespeicherten Cache, geschützt für den aktuellen Benutzer, der von anderen Anmeldeinformationen und Prozessen freigegeben werden kann.

Parameters:

tokenCachePersistenceOptions - Konfigurationsoptionen für den Tokencache

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierten Tokencacheoptionen.