ClientCredentialParameters Třída

Balíček:
com.microsoft.aad.msal4j
Artefakt Mavenu:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

Implementuje

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objekt obsahující parametry pro tok přihlašovacích údajů klienta Lze použít jako parametr pro acquireToken(ClientCredentialParameters parameters)

Souhrn metod

Modifikátor a typ Metoda a popis
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Tvůrce pro ClientCredentialParameters
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 ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

Vypočítá hodnotu hash klíče rozšířené mezipaměti ze všech součástí klíče mezipaměti.
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é

Nedoporučuje se pro produkční scénáře. V budoucí verzi se odebere a chování může být nahrazeno novým rozhraním API.

Získá další parametry dotazu, které se mají zahrnout do požadavku tokenu.
java.lang.String fmiPath()

Získá cestu FMI (federovaná spravovaná identita) pro scénáře identit agenta.
java.util.Set<java.lang.String> scopes()

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

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

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

builder

public static ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

Tvůrce pro ClientCredentialParameters

Parametry:

scopes - Aplikace oborů požaduje přístup k

Návraty:

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

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 ClientCredentialParametersBuilder#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ě.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

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

Výsledek je zapamatován, protože ClientCredentialParameters je neměnný po konstrukci. Používá se pro zápisy do mezipaměti (TokenCache) i čtení mezipaměti (tiché vyhledávání).

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é

Nedoporučuje se pro produkční scénáře. V budoucí verzi se odebere a chování může být nahrazeno novým rozhraním API.

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ě.

fmiPath

public String fmiPath()

Získá cestu FMI (federovaná spravovaná identita) pro scénáře identit agenta. Při nastavení fmi_path se odešle jako základní parametr v požadavku na token přihlašovacích údajů klienta, který definuje výsledný token na konkrétní identitu agenta.

Návraty:

cesta FMI nebo hodnota null, pokud není nastavená

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.

skipCache

public Boolean skipCache()

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".

Platí pro