InteractiveRequestParameters Klasse

  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters

Implementiert

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class InteractiveRequestParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Objekt, das Parameter für interaktive Anforderungen enthält. Kann als Parameter acquireToken(InteractiveRequestParameters parameters)für .

Weitere Details finden Sie unter https://aka.ms/msal4j-interactive-request.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static InteractiveRequestParametersBuilder builder(URI redirectUri)
ClaimsRequest claims()

Ansprüche, die über den OIDC-Anspruchsanforderungsparameter angefordert werden sollen und Anforderungen für Standard- und benutzerdefinierte Ansprüche zulassen

java.lang.String claimsChallenge()
java.lang.String domainHint()

Enthält einen Hinweis auf den Mandanten oder die Domäne, den der Benutzer für die Anmeldung verwenden soll.

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Fügt der Tokenanforderung zusätzliche Header hinzu.

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Fügt der Tokenanforderung zusätzliche Abfrageparameter hinzu.

int httpPollingTimeoutInSeconds()

Die Zeitspanne in Sekunden, die die Bibliothek auf ein Authentifizierungsergebnis wartet.

boolean instanceAware()

Wenn dieser Wert auf "true" festgelegt ist, enthält das Autorisierungsergebnis die Autorität für die Heimcloud des Benutzers, und diese Autorität wird für die Tokenanforderung anstelle der in der Anwendung festgelegten Autorität verwendet.

java.lang.String loginHint()

Kann verwendet werden, um das Feld "Benutzername/E-Mail-Adresse" der Anmeldeseite für den Benutzer vorab auszufüllen, wenn Sie den Benutzernamen/die E-Mail-Adresse vorab kennen.

Prompt prompt()

Geben Sie den Typ der benutzerinteraktion an, die erforderlich ist.

PopParameters proofOfPossession()
@lombok.NonNull java.net.URI redirectUri()

Umleitungs-URI, auf den MSAL auf den von Azure AD zurückgegebenen Autorisierungscode lauscht.

java.util.Set<java.lang.String> scopes()

Bereiche, für die die Anwendung Zugriff anfordert, und der Benutzer stimmt zu.

SystemBrowserOptions systemBrowserOptions()

Sets SystemBrowserOptions to be used by the PublicClientApplication

java.lang.String tenant()

Überschreibt den Mandantenwert in der Autoritäts-URL für diese Anforderung.

long windowHandle()

Das übergeordnete Fensterhandle, das zum Öffnen von UI-Elementen mit dem richtigen übergeordneten Element für Browserszenarien und Windows Konsolenanwendungen verwendet wird, sollte dieser Wert nicht für Windows Konsolenanwendungen festgelegt werden, msAL Java versucht, das Fensterhandle der Konsole zu ermitteln, wenn dieser Parameter nicht für Szenarien festgelegt ist, in denen MSAL Java ist für das Öffnen von UI-Elementen (z. B. bei Verwendung von MSALRuntime) verantwortlich, ist dieser Parameter erforderlich, und wenn keine Ausnahme festgelegt wird, wird eine Ausnahme ausgelöst.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Details zur Methode

builder

public static InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)

Parameter:

redirectUri

claims

public ClaimsRequest claims()

Ansprüche, die über den OIDC-Anspruchsanforderungsparameter angefordert werden sollen und Anforderungen für Standard- und benutzerdefinierte Ansprüche zulassen

claimsChallenge

public String claimsChallenge()

domainHint

public String domainHint()

Enthält einen Hinweis auf den Mandanten oder die Domäne, den der Benutzer für die Anmeldung verwenden soll. Der Wert des Domänenhinweiss ist eine registrierte Domäne für den Mandanten.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Fügt der Tokenanforderung zusätzliche Header hinzu.

extraQueryParameters

public Map<String,String> extraQueryParameters()

Fügt der Tokenanforderung zusätzliche Abfrageparameter hinzu.

httpPollingTimeoutInSeconds

public int httpPollingTimeoutInSeconds()

Die Zeitspanne in Sekunden, die die Bibliothek auf ein Authentifizierungsergebnis wartet. 120 Sekunden ist das Standardtimeout, es sei denn, sie wird hier mit einer anderen positiven ganzen Zahl außer Kraft gesetzt, wenn dieses Timeout auf 0 oder weniger festgelegt ist, wird es ignoriert, und die Bibliothek verwendet stattdessen ein 1-Sekunden-Timeout.

instanceAware

public boolean instanceAware()

Wenn dieser Wert auf "true" festgelegt ist, enthält das Autorisierungsergebnis die Autorität für die Heimcloud des Benutzers, und diese Autorität wird für die Tokenanforderung anstelle der in der Anwendung festgelegten Autorität verwendet.

loginHint

public String loginHint()

Kann verwendet werden, um das Feld "Benutzername/E-Mail-Adresse" der Anmeldeseite für den Benutzer vorab auszufüllen, wenn Sie den Benutzernamen/die E-Mail-Adresse vorab kennen. Häufig verwenden Apps diesen Parameter während der erneuten Authentifizierung, nachdem Sie den Benutzernamen bereits aus einer vorherigen Anmeldung mithilfe des preferred_username Anspruchs extrahiert haben.

prompt

public Prompt prompt()

Geben Sie den Typ der benutzerinteraktion an, die erforderlich ist.

proofOfPossession

public PopParameters proofOfPossession()

redirectUri

public @NonNull URI redirectUri()

Umleitungs-URI, auf den MSAL auf den von Azure AD zurückgegebenen Autorisierungscode lauscht. Sollte eine Loopbackadresse mit einem angegebenen Port sein (z. B. http://localhost:3671). Wenn kein Port angegeben ist, findet MSAL einen offenen Port. Weitere Informationen finden Sie unter https://aka.ms/msal4j-interactive-request.

scopes

public Set<String> scopes()

Bereiche, für die die Anwendung Zugriff anfordert, und der Benutzer stimmt zu.

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

Sets SystemBrowserOptions to be used by the PublicClientApplication

tenant

public String tenant()

Überschreibt den Mandantenwert in der Autoritäts-URL für diese Anforderung.

windowHandle

public long windowHandle()

Das übergeordnete Fensterhandle, das zum Öffnen von UI-Elementen mit dem richtigen übergeordneten Element für Browserszenarien und Windows Konsolenanwendungen verwendet wird, sollte dieser Wert nicht für Windows Konsolenanwendungen festgelegt werden, msAL Java versucht, das Fensterhandle der Konsole zu ermitteln, wenn dieser Parameter nicht für Szenarien festgelegt ist, in denen MSAL Java ist für das Öffnen von UI-Elementen (z. B. bei Verwendung von MSALRuntime) verantwortlich, ist dieser Parameter erforderlich, und wenn keine Ausnahme festgelegt wird, wird eine Ausnahme ausgelöst.

Gilt für: