UserFederatedIdentityCredentialParameters Třída

  • java.lang.Object
    • com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters

Implementuje

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objekt obsahující parametry toku přihlašovacích údajů federované identity uživatele (user_fic). Používá se pro část 3 protokolu identity agenta, kde se pro token s oborem uživatele vyměňují přihlašovací údaje federované identity (získané z leg 2).

Lze použít jako parametr pro acquireToken(UserFederatedIdentityCredentialParameters parameters)

Souhrn metod

Modifikátor a typ Metoda a popis
java.lang.String assertion()
static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Tvůrce pro UserFederatedIdentityCredentialParameters použití hlavního názvu uživatele (UPN)

static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Tvůrce pro UserFederatedIdentityCredentialParameters použití ID objektu uživatele

ClaimsRequest claims()

Získá parametr žádosti o deklarace identity, který se odešle s požadavkem na ověření.

java.lang.String clientClaims()

Deklarace identity pocházející z klienta nastavené prostřednictvím UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String).

java.lang.String computeExtCacheKeyHash()

Vypočítá hodnotu hash klíče rozšířené mezipaměti ze všech součástí klíče mezipaměti nebo prázdný řetězec, pokud neexistuje žádný.

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Získá další hlavičky HTTP, které se zahrnou do požadavku tokenu.

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Zastaralé

Prezentovat pouze pro splnění kontraktu IAcquireTokenParameters rozhraní. Nedoporučuje se používat – toto rozhraní API je naplánováno pro odebrání všech tříd parametrů a v budoucí verzi bude nahrazeno novým mechanismem.

Získá další parametry dotazu, které se mají zahrnout do požadavku tokenu.

boolean forceRefresh()
java.util.Set<java.lang.String> scopes()

Získá sadu oborů (oprávnění) požadovaných pro přístupový token.

java.lang.String tenant()

Získá identifikátor tenanta pro požadavek tokenu.

java.lang.String username()
java.util.UUID userObjectId()

Metody zděděné od 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

Podrobnosti metody

assertion

public String assertion()

Návraty:

kontrolní výraz přihlašovacích údajů federované identity (JWT)

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Tvůrce pro UserFederatedIdentityCredentialParameters použití hlavního názvu uživatele (UPN)

Parametry:

scopes - Aplikace oborů požaduje přístup k
username - hlavní název uživatele (např. "user@contoso.com")
assertion - kontrolní výraz přihlašovacích údajů federované identity (JWT) získaný z leg 2

Návraty:

tvůrce, který lze použít k vytvoření UserFederatedIdentityCredentialParameters

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Tvůrce pro UserFederatedIdentityCredentialParameters použití ID objektu uživatele

Parametry:

scopes - Aplikace oborů požaduje přístup k
userObjectId - ID objektu (OID) cílového uživatele
assertion - kontrolní výraz přihlašovacích údajů federované identity (JWT) získaný z leg 2

Návraty:

tvůrce, který lze použít k vytvoření UserFederatedIdentityCredentialParameters

claims

public ClaimsRequest claims()

Získá parametr žádosti o deklarace identity, který se odešle s požadavkem na ověření.

Parametr žádosti o deklarace identity se dá použít k vyžádání konkrétních deklarací identity, které se mají v tokenu vrátit, k vyžádání vícefaktorového ověřování nebo k řízení dalších aspektů vystavování tokenů.

clientClaims

public String clientClaims()

Deklarace identity pocházející z klienta nastavené prostřednictvím UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). Předáno koncovému bodu tokenu jako parametr OAuth claims a používá se jako součást klíče rozšířené mezipaměti, aby se jedinečné hodnoty deklarací identity ukážily samostatně.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Vypočítá hodnotu hash klíče rozšířené mezipaměti ze všech součástí klíče mezipaměti nebo prázdný řetězec, pokud neexistuje žádný. Výsledek se zapisuje, protože parametry jsou po konstrukci neměnné.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Získá další hlavičky HTTP, které se zahrnou do požadavku tokenu.

Tyto hlavičky se přidají do požadavků HTTP odeslaných do koncového bodu tokenu. To může být užitečné pro scénáře vyžadující vlastní hlavičky pro proxy servery nebo pro účely diagnostiky.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Zastaralé

Prezentovat pouze pro splnění kontraktu IAcquireTokenParameters rozhraní. Nedoporučuje se používat – toto rozhraní API je naplánováno pro odebrání všech tříd parametrů a v budoucí verzi bude nahrazeno novým mechanismem.

Získá další parametry dotazu, které se mají zahrnout do požadavku tokenu.

Tyto parametry se přidají do řetězce dotazu v požadavcích na koncové body autorizace a tokenu. To může být užitečné pro scénáře vyžadující vlastní parametry, které nejsou explicitně podporovány v knihovně.

forceRefresh

public boolean forceRefresh()

Návraty:

zda se má obejít mezipaměť tokenů a vynutit novou žádost o token

scopes

public Set<String> scopes()

Získá sadu oborů (oprávnění) požadovaných pro přístupový token.

Obory představují oprávnění, ke kterým aplikace žádá o přístup.

tenant

public String tenant()

Získá identifikátor tenanta pro požadavek tokenu.

Po zadání tato hodnota přepíše tenanta zadaného v adrese URL autority aplikace. Může to být ID tenanta (GUID), název domény nebo jedna ze speciálních hodnot, jako jsou "společné" nebo "organizace".

username

public String username()

Návraty:

hlavní název uživatele (UPN) cílového uživatele nebo hodnota null, pokud byl uživatel identifikován ID objektu

userObjectId

public UUID userObjectId()

Návraty:

ID objektu cílového uživatele nebo hodnotu null, pokud byl uživatel identifikován hlavním uživatelem uživatele (UPN)

Platí pro