AuthorizationRequestUrlParameters.Builder Klasse

  • java.lang.Object
    • com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder

public static class AuthorizationRequestUrlParameters.Builder

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Builder()

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
AuthorizationRequestUrlParameters build()
Builder claims(ClaimsRequest val)

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

Builder claimsChallenge(String val)

In Fällen, in denen Azure AD-Mandantenadministrator Richtlinien für bedingten Zugriff aktiviert hat und die Richtlinie nicht erfüllt wurde, enthalten Ansprüche,MsalServiceException denen zugestimmt werden muss.

Builder codeChallenge(String val)

Wird verwendet, um die Autorisierungscodeerteilung über proof of Key for Code Exchange (PKCE) zu sichern.

Builder codeChallengeMethod(String val)

Die Methode, die zum Codieren der Codeüberprüfung für den Codeabfrageparameter verwendet wird.

Builder correlationId(String val)

Bezeichner, der zum Korrelieren von Anforderungen für Telemetriezwecke verwendet wird.

Builder domainHint(String val)

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

Builder extraQueryParameters(Map<String,String> val)

Abfrageparameter, die Sie der Anforderung hinzufügen können, zusätzlich zur Liste der bereits bereitgestellten Parameter.

Builder extraScopesToConsent(Set<String> val)

Bereiche, auf die Sie den Endbenutzer bitten können, vorab zuzustimmen, zusätzlich zu Bereichen, auf die die Anwendung Zugriff anfordert.

Builder instanceAware(boolean val)

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.

Builder loginHint(String val)

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.

Builder nonce(String val)

Ein in der Anforderung enthaltener Wert, der ebenfalls in der Tokenantwort zurückgegeben wird.

Builder prompt(Prompt val)

Gibt den Typ der erforderlichen Benutzerinteraktion an.

Builder redirectUri(String val)

Der Umleitungs-URI, in dem Authentifizierungsantworten von Ihrer Anwendung empfangen werden können.

Builder responseMode(ResponseMode val)

Gibt die Methode an, die verwendet werden soll, um das Authentifizierungsergebnis an Ihre App zu senden.

Builder scopes(Set<String> val)

Bereiche, auf die die Anwendung Zugriff anfordert, und der Benutzer stimmt zu.

Builder state(String val)

Ein in der Anforderung enthaltener Wert, der ebenfalls in der Tokenantwort zurückgegeben wird.

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 zum Konstruktor

Builder

public Builder()

Details zur Methode

build

public AuthorizationRequestUrlParameters build()

claims

public AuthorizationRequestUrlParameters.Builder claims(ClaimsRequest val)

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

Parameter:

val

claimsChallenge

public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)

In Fällen, in denen Azure AD-Mandantenadministrator Richtlinien für bedingten Zugriff aktiviert hat und die Richtlinie nicht erfüllt wurde, enthalten Ansprüche,MsalServiceException denen zugestimmt werden muss.

Parameter:

val

codeChallenge

public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)

Wird verwendet, um die Autorisierungscodeerteilung über proof of Key for Code Exchange (PKCE) zu sichern. Erforderlich, wenn codeChallenge enthalten ist. Weitere Informationen finden Sie im PKCE RCF: https://tools.ietf.org/html/rfc7636

Parameter:

val

codeChallengeMethod

public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)

Die Methode, die zum Codieren der Codeüberprüfung für den Codeabfrageparameter verwendet wird. Dies kann eine einfache oder S256 sein. Wenn ausgeschlossen, wird angenommen, dass die Codeabfrage Nur-Text ist. Weitere Informationen finden Sie im PKCE RCF: https://tools.ietf.org/html/rfc7636

Parameter:

val

correlationId

public AuthorizationRequestUrlParameters.Builder correlationId(String val)

Bezeichner, der zum Korrelieren von Anforderungen für Telemetriezwecke verwendet wird. In der Regel eine GUID.

Parameter:

val

domainHint

public AuthorizationRequestUrlParameters.Builder domainHint(String val)

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:

val

extraQueryParameters

public AuthorizationRequestUrlParameters.Builder extraQueryParameters(Map<String,String> val)

Abfrageparameter, die Sie der Anforderung hinzufügen können, zusätzlich zur Liste der bereits bereitgestellten Parameter.

Parameter:

val

extraScopesToConsent

public AuthorizationRequestUrlParameters.Builder extraScopesToConsent(Set<String> val)

Bereiche, auf die Sie den Endbenutzer bitten können, vorab zuzustimmen, zusätzlich zu Bereichen, auf die die Anwendung Zugriff anfordert.

Parameter:

val

instanceAware

public AuthorizationRequestUrlParameters.Builder instanceAware(boolean val)

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:

val

loginHint

public AuthorizationRequestUrlParameters.Builder loginHint(String val)

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:

val

nonce

public AuthorizationRequestUrlParameters.Builder nonce(String val)

Ein in der Anforderung enthaltener Wert, der ebenfalls in der Tokenantwort zurückgegeben wird. Ein zufällig generierter eindeutiger Wert wird in der Regel verwendet, um Websiteanforderungs-Fälschungsangriffe zu verhindern.

Parameter:

val

prompt

public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)

Gibt den Typ der erforderlichen Benutzerinteraktion an. Mögliche Werte sind Prompt

Parameter:

val

redirectUri

public AuthorizationRequestUrlParameters.Builder redirectUri(String val)

Der Umleitungs-URI, in dem Authentifizierungsantworten von Ihrer Anwendung empfangen werden können. Es muss genau mit einer der Umleitungs-URIs übereinstimmen, die im Azure-Portal registriert sind.

Parameter:

val

responseMode

public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)

Gibt die Methode an, die verwendet werden soll, um das Authentifizierungsergebnis an Ihre App zu senden.

Parameter:

val

scopes

public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)

Bereiche, auf die die Anwendung Zugriff anfordert, und der Benutzer stimmt zu.

Parameter:

val

state

public AuthorizationRequestUrlParameters.Builder state(String val)

Ein in der Anforderung enthaltener Wert, der ebenfalls in der Tokenantwort zurückgegeben wird. Ein zufällig generierter eindeutiger Wert wird in der Regel verwendet, um Websiteanforderungs-Fälschungsangriffe zu verhindern. Der Zustand wird auch verwendet, um Informationen zum Status des Benutzers in der App zu codieren, bevor die Authentifizierungsanforderung aufgetreten ist.

Parameter:

val

Gilt für: