ClientCredentialParameters Klasse

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

Implementiert

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objekt, das Parameter für den Clientanmeldeinformationsfluss enthält. Kann als Parameter verwendet werden, um acquireToken(ClientCredentialParameters parameters)

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Generator für ClientCredentialParameters
ClaimsRequest claims()

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

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

Berechnet den erweiterten Cacheschlüsselhash aus allen Cacheschlüsselkomponenten.
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.lang.String fmiPath()

Ruft den FMI-Pfad (Federated Managed Identity) für Agentidentitätsszenarien ab.
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.

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 ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

Generator für ClientCredentialParameters

Parameter:

scopes - Bereichsanwendung fordert Zugriff auf

Gibt zurück:

Generator, der zum Erstellen von ClientCredentialParameters 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 ClientCredentialParametersBuilder#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.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Berechnet den erweiterten Cacheschlüsselhash aus allen Cacheschlüsselkomponenten. Gibt eine leere Zeichenfolge zurück, wenn keine Komponenten vorhanden sind.

Das Ergebnis wird gespeichert, da ClientCredentialParameters nach der Konstruktion unveränderlich ist. Wird sowohl von Cache-Schreibvorgängen (TokenCache) als auch von Cache-Lesevorgängen (automatische Suche) verwendet.

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.

fmiPath

public String fmiPath()

Ruft den FMI-Pfad (Federated Managed Identity) für Agentidentitätsszenarien ab. Wenn festgelegt, fmi_path wird als Body-Parameter in der Clientanmeldeinformationstokenanforderung gesendet, der das resultierende Token auf eine bestimmte Agent-Identität festlegt.

Gibt zurück:

der FMI-Pfad oder null, wenn er nicht festgelegt ist

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.

Gilt für: