ClientCredentialParameters Classe

Pacchetto:: com.microsoft.aad.msal4j

Artefatto Maven:: com.microsoft.azure:msal4j:1.26.0

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

Implementazioni

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Oggetto contenente parametri per il flusso delle credenziali client. Può essere usato come parametro per acquireToken(ClientCredentialParameters parameters)

Riepilogo dei metodi

Modificatore e tipo	Metodo e descrizione
static ClientCredentialParametersBuilder	builder(Set<String> scopes) Generatore per ClientCredentialParameters
ClaimsRequest	claims() Ottiene il parametro della richiesta di attestazioni che verrà inviato con la richiesta di autenticazione.
java.lang.String	clientClaims() Attestazioni originate dal client impostate tramite ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential	clientCredential()
java.lang.String	computeExtCacheKeyHash() Calcola l'hash della chiave della cache estesa da tutti i componenti chiave della cache.
java.util.Map<java.lang.String,java.lang.String>	extraHttpHeaders() Ottiene intestazioni HTTP aggiuntive da includere nella richiesta di token.
java.util.Map<java.lang.String,java.lang.String>	extraQueryParameters() Deprecato Non consigliato per gli scenari di produzione. Verrà rimosso in una versione futura e il comportamento potrebbe essere sostituito da una nuova API. Ottiene parametri di query aggiuntivi da includere nella richiesta di token.
java.lang.String	fmiPath() Ottiene il percorso fmi (identità gestita federata) per gli scenari di identità dell'agente.
java.util.Set<java.lang.String>	scopes() Ottiene il set di ambiti (autorizzazioni) richiesti per il token di accesso.
java.lang.Boolean	skipCache()
java.lang.String	tenant() Ottiene l'identificatore del tenant per la richiesta di token.

Metodi ereditati da 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

Dettagli metodo

builder

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

Generatore per ClientCredentialParameters

Parametri:

scopes - L'applicazione scopes richiede l'accesso a

Valori restituiti:

generatore che può essere usato per costruire ClientCredentialParameters

claims

public ClaimsRequest claims()

Ottiene il parametro della richiesta di attestazioni che verrà inviato con la richiesta di autenticazione.

Il parametro della richiesta di attestazioni può essere usato per richiedere la restituzione di attestazioni specifiche nel token, per richiedere l'autenticazione MFA o per controllare altri aspetti del rilascio dei token.

clientClaims

public String clientClaims()

Attestazioni originate dal client impostate tramite ClientCredentialParametersBuilder#claimsFromClient(String). Inoltrato all'endpoint del token come parametro OAuth claims e usato come parte della chiave della cache estesa in modo che i valori di attestazione distinti vengano memorizzati nella cache separatamente.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcola l'hash della chiave della cache estesa da tutti i componenti chiave della cache. Restituisce una stringa vuota se non sono presenti componenti.

Il risultato viene memorizzato nella nota poiché ClientCredentialParameters non è modificabile dopo la costruzione. Usato sia dalle scritture della cache (TokenCache) che dalle letture della cache (ricerca invisibile all'utente).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Ottiene intestazioni HTTP aggiuntive da includere nella richiesta di token.

Queste intestazioni verranno aggiunte alle richieste HTTP inviate all'endpoint del token. Ciò può essere utile per gli scenari che richiedono intestazioni personalizzate per proxy o per scopi diagnostici.

extraQueryParameters

public Map<String,String> extraQueryParameters()

Deprecato

Non consigliato per gli scenari di produzione. Verrà rimosso in una versione futura e il comportamento potrebbe essere sostituito da una nuova API.

Ottiene parametri di query aggiuntivi da includere nella richiesta di token.

Questi parametri verranno aggiunti alla stringa di query nelle richieste agli endpoint di autorizzazione e token. Ciò può essere utile per gli scenari che richiedono parametri personalizzati che non sono supportati in modo esplicito nella libreria.

fmiPath

public String fmiPath()

Ottiene il percorso fmi (identità gestita federata) per gli scenari di identità dell'agente. Quando impostato, fmi_path viene inviato come parametro del corpo nella richiesta di token delle credenziali client, che definisce l'ambito del token risultante a un'identità dell'agente specifica.

Valori restituiti:

percorso FMI o null se non impostato

scopes

public Set<String> scopes()

Ottiene il set di ambiti (autorizzazioni) richiesti per il token di accesso.

Gli ambiti rappresentano le autorizzazioni a cui l'applicazione richiede l'accesso.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Ottiene l'identificatore del tenant per la richiesta di token.

Se specificato, questo valore esegue l'override del tenant specificato nell'URL dell'autorità dell'applicazione. Può essere un ID tenant (GUID), un nome di dominio o uno dei valori speciali, ad esempio "common" o "organizations".