OnBehalfOfParameters Klasse

Paket:
com.microsoft.aad.msal4j
Maven-Artefakt:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.OnBehalfOfParameters

Implementiert

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objekt, das Parameter für "On-Behalf-Of"-Fluss enthält. Kann als Parameter verwendet werden, um acquireToken(OnBehalfOfParameters parameters)

Weitere Einzelheiten finden Sie unter https://aka.ms/msal4j-on-behalf-of

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static OnBehalfOfParametersBuilder builder(Set<String> scopes, UserAssertion userAssertion)

Generator für OnBehalfOfParameters
ClaimsRequest claims()

Ruft den Anspruchsanforderungsparameter ab, der mit der Authentifizierungsanforderung gesendet wird.
java.lang.String clientClaims()

Vom Client stammende Ansprüche, die über OnBehalfOfParametersBuilder#claimsFromClient(String).
java.lang.String computeExtCacheKeyHash()

Berechnet den erweiterten Cacheschlüsselhash aus allen Komponenten des Cacheschlüssels oder einer leeren Zeichenfolge, wenn keine vorhanden ist.
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Ruft zusätzliche HTTP-Header ab, die in die Tokenanforderung eingeschlossen werden sollen.
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Als veraltet markiert

Für Produktionsszenarien nicht empfohlen. Es wird in einer zukünftigen Version entfernt, und das Verhalten kann durch eine neue API ersetzt werden.

Ruft zusätzliche Abfrageparameter ab, die in die Tokenanforderung eingeschlossen werden sollen.
java.util.Set<java.lang.String> scopes()

Ruft den Satz von Bereichen (Berechtigungen) ab, die für das Zugriffstoken angefordert werden.
java.lang.Boolean skipCache()
java.lang.String tenant()

Ruft den Mandantenbezeichner für die Tokenanforderung ab.
IUserAssertion userAssertion()

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 OnBehalfOfParameters.OnBehalfOfParametersBuilder builder(Set<String> scopes, UserAssertion userAssertion)

Generator für OnBehalfOfParameters

Parameter:

scopes - Bereichsanwendung fordert Zugriff auf
userAssertion - UserAssertion erstellt von empfangenen Zugriffstoken

Gibt zurück:

Generator, der zum Erstellen von OnBehalfOfParameters verwendet werden kann

claims

public ClaimsRequest claims()

Ruft den Anspruchsanforderungsparameter ab, der mit der Authentifizierungsanforderung gesendet wird.

Der Anspruchsanforderungsparameter kann verwendet werden, um bestimmte Ansprüche anzufordern, die im Token zurückgegeben werden sollen, die MFA-Authentifizierung anzufordern oder andere Aspekte der Tokenausstellung zu steuern.

clientClaims

public String clientClaims()

Vom Client stammende Ansprüche, die über OnBehalfOfParametersBuilder#claimsFromClient(String). Wird als OAuth-Parameter claims an den Tokenendpunkt weitergeleitet und als Teil des erweiterten Cacheschlüssels verwendet, sodass unterschiedliche Anspruchswerte separat zwischengespeichert werden.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Berechnet den erweiterten Cacheschlüsselhash aus allen Komponenten des Cacheschlüssels oder einer leeren Zeichenfolge, wenn keine vorhanden ist. Das Ergebnis wird gespeichert, da die Parameter nach der Konstruktion unveränderlich sind.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Ruft zusätzliche HTTP-Header ab, die in die Tokenanforderung eingeschlossen werden sollen.

Diese Header werden den HTTP-Anforderungen hinzugefügt, die an den Tokenendpunkt gesendet werden. Dies kann für Szenarien nützlich sein, die benutzerdefinierte Header für Proxys oder für Diagnosezwecke erfordern.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Als veraltet markiert

Für Produktionsszenarien nicht empfohlen. Es wird in einer zukünftigen Version entfernt, und das Verhalten kann durch eine neue API ersetzt werden.

Ruft zusätzliche Abfrageparameter ab, die in die Tokenanforderung eingeschlossen werden sollen.

Diese Parameter werden der Abfragezeichenfolge in Anforderungen an die Autorisierungs- und Tokenendpunkte hinzugefügt. Dies kann für Szenarien hilfreich sein, die benutzerdefinierte Parameter erfordern, die in der Bibliothek nicht explizit unterstützt werden.

scopes

public Set<String> scopes()

Ruft den Satz von Bereichen (Berechtigungen) ab, die für das Zugriffstoken angefordert werden.

Bereiche stellen die Berechtigungen dar, auf die die Anwendung Zugriff anfordert.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Ruft den Mandantenbezeichner für die Tokenanforderung ab.

Wenn dieser Wert angegeben wird, überschreibt dieser Wert den mandanten, der in der Autoritäts-URL der Anwendung angegeben ist. Dabei kann es sich um eine Mandanten-ID (GUID), einen Domänennamen oder einen der speziellen Werte wie "common" oder "organizations" handeln.

userAssertion

public IUserAssertion userAssertion()

Gilt für: