InteractiveRequestParameters.InteractiveRequestParametersBuilder Klasse

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

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

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

InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)
InteractiveRequestParametersBuilder domainHint(String domainHint)

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

InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Fügt der Tokenanforderung zusätzliche Header hinzu.

InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Fügt der Tokenanforderung zusätzliche Abfrageparameter hinzu.

InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

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

InteractiveRequestParametersBuilder instanceAware(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.

InteractiveRequestParametersBuilder loginHint(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.

InteractiveRequestParametersBuilder prompt(Prompt prompt)

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

InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Legt die Pop-Parameterfür diese Anforderung fest, sodass die Anforderung Token für den Nachweis des Besitzes anstelle von Bearertoken abrufen kann. Weitere Informationen finden Sie unter PopParameters und https://aka.ms/msal4j-pop

InteractiveRequestParametersBuilder redirectUri(@NonNull URI redirectUri)

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

InteractiveRequestParametersBuilder scopes(Set<String> scopes)

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

InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sets SystemBrowserOptions to be used by the PublicClientApplication

InteractiveRequestParametersBuilder tenant(String tenant)

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

java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(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

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

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

Parameter:

claims

Gibt zurück:

this.

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Parameter:

claimsChallenge

Gibt zurück:

this.

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(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.

Parameter:

domainHint

Gibt zurück:

this.

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Fügt der Tokenanforderung zusätzliche Header hinzu.

Parameter:

extraHttpHeaders

Gibt zurück:

this.

extraQueryParameters

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Fügt der Tokenanforderung zusätzliche Abfrageparameter hinzu.

Parameter:

extraQueryParameters

Gibt zurück:

this.

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(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.

Parameter:

httpPollingTimeoutInSeconds

Gibt zurück:

this.

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(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.

Parameter:

instanceAware

Gibt zurück:

this.

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(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.

Parameter:

loginHint

Gibt zurück:

this.

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

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

Parameter:

prompt

Gibt zurück:

this.

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Legt die PopParameters für diese Anforderung fest und ermöglicht es der Anforderung, Besitznachweistoken anstelle von Bearertoken abzurufen. Weitere Informationen finden Sie unter PopParameters und https://aka.ms/msal4j-pop

Parameter:

httpMethod - eine gültige HTTP-Methode, z. B. "GET" oder "POST"
uri - der URI für die nachgeschaltete geschützte API, auf die die Anwendung zugreifen möchte, z. B. https://graph.microsoft.com/beta/me/profile
nonce - eine Zeichenfolge, die durch Aufrufen der Ressource (z. B. Microsoft Graph) nicht authentifiziert und analysiert wird, den WWW-Authenticate Header, der mit dem Popauthentifizierungsschema verknüpft ist, und extrahieren den Nonce-Parameter oder bei nachfolgenden Aufrufen durch Analysieren des Autheticate-Info Headers und Extrahieren des nextnonce-Parameters.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(@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.

Parameter:

redirectUri

Gibt zurück:

this.

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

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

Parameter:

scopes

Gibt zurück:

this.

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sets SystemBrowserOptions to be used by the PublicClientApplication

Parameter:

systemBrowserOptions

Gibt zurück:

this.

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

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

Parameter:

tenant

Gibt zurück:

this.

toString

public String toString()

Überschreibt:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(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.

Parameter:

windowHandle

Gibt zurück:

this.

Gilt für: