UserFederatedIdentityCredentialParameters Klasse
- java.
lang. Object - com.
microsoft. aad. msal4j. UserFederatedIdentityCredentialParameters
- com.
Implementiert
public class UserFederatedIdentityCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
Objekt, das Parameter für den Benutzerverbundidentitäts-Anmeldeinformationsfluss (user_fic) enthält. Dies wird für Leg 3 des Agent-Identitätsprotokolls verwendet, bei dem eine Verbundidentitäts-Anmeldeinformationen (abgerufen von Leg 2) für ein Benutzertoken ausgetauscht wird.
Kann als Parameter verwendet werden, um acquireToken(UserFederatedIdentityCredentialParameters parameters)
Methodenzusammenfassung
| Modifizierer und Typ | Methode und Beschreibung |
|---|---|
| java.lang.String | assertion() |
|
static
User |
builder(Set<String> scopes, String username, String assertion)
Generator für UserFederatedIdentityCredentialParameters die Verwendung eines UPN (Benutzerprinzipalname). |
|
static
User |
builder(Set<String> scopes, UUID userObjectId, String assertion)
Generator für UserFederatedIdentityCredentialParameters die Verwendung einer Benutzerobjekt-ID. |
|
Claims |
claims()
Ruft den Anspruchsanforderungsparameter ab, der mit der Authentifizierungsanforderung gesendet wird. |
| java.lang.String |
clientClaims()
Vom Client stammende Ansprüche, die über UserFederatedIdentityCredentialParametersBuilder#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
Nur vorhanden, um den IAcquireTokenParameters Schnittstellenvertrag zu erfüllen. Nicht für die Verwendung empfohlen – diese API wird für die Entfernung in allen Parameterklassen geplant und wird in einer zukünftigen Version durch einen neuen Mechanismus ersetzt.
Ruft zusätzliche Abfrageparameter ab, die in die Tokenanforderung eingeschlossen werden sollen. |
| boolean | forceRefresh() |
| java.util.Set<java.lang.String> |
scopes()
Ruft den Satz von Bereichen (Berechtigungen) ab, die für das Zugriffstoken angefordert werden. |
| java.lang.String |
tenant()
Ruft den Mandantenbezeichner für die Tokenanforderung ab. |
| java.lang.String | username() |
| java.util.UUID | userObjectId() |
Geerbte Methoden von java.lang.Object
Details zur Methode
assertion
public String assertion()
Gibt zurück:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)
Generator für UserFederatedIdentityCredentialParameters die Verwendung eines UPN (Benutzerprinzipalname).
Parameter:
Gibt zurück:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)
Generator für UserFederatedIdentityCredentialParameters die Verwendung einer Benutzerobjekt-ID.
Parameter:
Gibt zurück:
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 UserFederatedIdentityCredentialParametersBuilder#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
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.
forceRefresh
public boolean forceRefresh()
Gibt zurück:
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.
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.
username
public String username()
Gibt zurück:
userObjectId
public UUID userObjectId()
Gibt zurück: