ClientCredentialParameters Klas

Pakket:: com.microsoft.aad.msal4j

Maven-artefact:: com.microsoft.azure:msal4j:1.26.0

java.lang.Object
- com.microsoft.aad.msal4j.ClientCredentialParameters

Implementeringen

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Object met parameters voor clientreferentiestroom. Kan worden gebruikt als parameter voor acquireToken(ClientCredentialParameters parameters)

Methodesamenvatting

Modifier en type	Methode en beschrijving
static ClientCredentialParametersBuilder	builder(Set<String> scopes) Opbouwfunctie voor ClientCredentialParameters
ClaimsRequest	claims() Hiermee haalt u de claimaanvraagparameter op die wordt verzonden met de verificatieaanvraag.
java.lang.String	clientClaims() Claims die afkomstig zijn van de client via ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential	clientCredential()
java.lang.String	computeExtCacheKeyHash() Berekent de uitgebreide cachesleutel-hash van alle onderdelen van de cachesleutel.
java.util.Map<java.lang.String,java.lang.String>	extraHttpHeaders() Hiermee worden extra HTTP-headers opgehaald die moeten worden opgenomen in de tokenaanvraag.
java.util.Map<java.lang.String,java.lang.String>	extraQueryParameters() Afgeschaft Niet aanbevolen voor productiescenario's. Deze wordt verwijderd in een toekomstige release en het gedrag wordt mogelijk vervangen door een nieuwe API. Hiermee worden extra queryparameters opgehaald die moeten worden opgenomen in de tokenaanvraag.
java.lang.String	fmiPath() Hiermee haalt u het FMI-pad (Federatieve beheerde identiteit) op voor agentidentiteitsscenario's.
java.util.Set<java.lang.String>	scopes() Hiermee haalt u de set bereiken (machtigingen) op die zijn aangevraagd voor het toegangstoken.
java.lang.Boolean	skipCache()
java.lang.String	tenant() Hiermee haalt u de tenant-id voor de tokenaanvraag op.

Methoden overgenomen van 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

Methodedetails

builder

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

Opbouwfunctie voor ClientCredentialParameters

Parameters:

scopes - scopes-toepassing vraagt toegang tot

Retouren:

opbouwfunctie die kan worden gebruikt om ClientCredentialParameters samen te stellen

claims

public ClaimsRequest claims()

Hiermee haalt u de claimaanvraagparameter op die wordt verzonden met de verificatieaanvraag.

De claimaanvraagparameter kan worden gebruikt om specifieke claims aan te vragen die moeten worden geretourneerd in het token, om MFA-verificatie aan te vragen of om andere aspecten van tokenuitgifte te beheren.

clientClaims

public String clientClaims()

Claims die afkomstig zijn van de client via ClientCredentialParametersBuilder#claimsFromClient(String). Doorgestuurd naar het tokeneindpunt als de OAuth-parameter claims en wordt gebruikt als onderdeel van de uitgebreide cachesleutel, zodat afzonderlijke claimwaarden afzonderlijk in de cache worden opgeslagen.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Berekent de uitgebreide cachesleutel-hash van alle onderdelen van de cachesleutel. Retourneert een lege tekenreeks als er geen onderdelen aanwezig zijn.

Het resultaat wordt onthouden omdat ClientCredentialParameters onveranderbaar is na de constructie. Wordt gebruikt door zowel cache-schrijfbewerkingen (TokenCache) als cacheleesbewerkingen (op de achtergrond).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Hiermee worden extra HTTP-headers opgehaald die moeten worden opgenomen in de tokenaanvraag.

Deze headers worden toegevoegd aan de HTTP-aanvragen die naar het tokeneindpunt worden verzonden. Dit kan handig zijn voor scenario's waarvoor aangepaste headers zijn vereist voor proxy's of voor diagnostische doeleinden.

extraQueryParameters

public Map<String,String> extraQueryParameters()

Afgeschaft

Niet aanbevolen voor productiescenario's. Deze wordt verwijderd in een toekomstige release en het gedrag wordt mogelijk vervangen door een nieuwe API.

Hiermee worden extra queryparameters opgehaald die moeten worden opgenomen in de tokenaanvraag.

Deze parameters worden toegevoegd aan de querytekenreeks in aanvragen voor de autorisatie- en tokeneindpunten. Dit kan handig zijn voor scenario's waarvoor aangepaste parameters zijn vereist die niet expliciet worden ondersteund in de bibliotheek.

fmiPath

public String fmiPath()

Hiermee haalt u het FMI-pad (Federatieve beheerde identiteit) op voor agentidentiteitsscenario's. Wanneer deze instelling is ingesteld, fmi_path wordt deze verzonden als een hoofdtekstparameter in de tokenaanvraag voor clientreferenties, waardoor het resulterende token wordt beperkt tot een specifieke agentidentiteit.

Retouren:

het FMI-pad of null als dit niet is ingesteld

scopes

public Set<String> scopes()

Hiermee haalt u de set bereiken (machtigingen) op die zijn aangevraagd voor het toegangstoken.

Bereiken vertegenwoordigen de machtigingen waartoe de toepassing toegang aanvraagt.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Hiermee haalt u de tenant-id voor de tokenaanvraag op.

Wanneer deze waarde is opgegeven, wordt de tenant die is opgegeven in de instantie-URL van de toepassing overschreven. Dit kan een tenant-id (GUID), domeinnaam of een van de speciale waarden zijn, zoals 'common' of 'organizations'.