AcquireTokenForClientParameterBuilder Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Generatore per AcquireTokenForClient (usato nei flussi di credenziali client, nelle applicazioni daemon). Fare riferimento a https://aka.ms/msal-net-client-credentials
public sealed class AcquireTokenForClientParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder>
type AcquireTokenForClientParameterBuilder = class
inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>
Public NotInheritable Class AcquireTokenForClientParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenForClientParameterBuilder)
- Ereditarietà
Metodi
| Nome | Descrizione |
|---|---|
| ExecuteAsync() |
Esegue la richiesta token in modo asincrono. (Ereditato da BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Esegue la richiesta token in modo asincrono, con la possibilità di annullare il metodo asincrono. (Ereditato da AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Convalida i parametri dell'operazione AcquireToken. (Ereditato da AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Aggiunge un'autorità nota corrispondente a un server ADFS. Vedete https://aka.ms/msal-net-adfs. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Specifica un attributo identity da includere nella richiesta di token. I valori dell'attributo verranno restituiti come attestazione nel token denominato "xms_attr" nelle attestazioni del token di accesso. Viene in genere usato con scenari fmi (identità gestita federata). Esempio di json dell'attributo: "{"sg1":"0000-0000-0001","sg2":["0000-0000-0002","0000-0000-00003","0000-0000-0004"]}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Aggiunge un'autorità di Azure AD nota all'applicazione per l'accesso degli utenti che specificano il gruppo di destinatari di accesso (il cloud è il cloud Azure cloud pubblico). Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Obsoleti.
Aggiunge un'autorità Azure AD nota all'applicazione per l'accesso degli utenti che specificano l'istanza cloud e il gruppo di destinatari dell'accesso. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Aggiunge un'autorità di Azure AD nota all'applicazione per consentire agli utenti di accedere da una singola organizzazione (applicazione a tenant singolo) descritta dall'istanza cloud e dal relativo ID tenant. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Aggiunge un'autorità di Azure AD nota all'applicazione per l'accesso degli utenti da una singola organizzazione (applicazione a tenant singolo) descritta dall'istanza cloud e dal relativo nome di dominio o ID tenant. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Autorità specifica per cui viene richiesto il token. Il passaggio di un valore diverso rispetto a quello configurato nel costruttore dell'applicazione restringe la selezione a un tenant specifico. Questo non modifica il valore configurato nell'applicazione. Questa operazione è specifica per le applicazioni che gestiscono più account, ad esempio un client di posta elettronica con più cassette postali. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Aggiunge un'autorità di Azure AD nota all'applicazione per l'accesso degli utenti da una singola organizzazione (applicazione a tenant singolo) specificata dal relativo ID tenant. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Obsoleti.
Importante: usare withTenantId o WithTenantIdFromAuthority oppure WithB2CAuthority per le autorità B2C. Aggiunge un'autorità di Azure AD nota all'applicazione per l'accesso degli utenti da una singola organizzazione (applicazione a tenant singolo) descritta dal nome di dominio. Vedete https://aka.ms/msal-net-application-configuration. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Obsoleti.
Usare WithAzureRegion nell'oggetto ConfidentialClientApplicationBuilder |
| WithB2CAuthority(String) |
Aggiunge un'autorità nota corrispondente a un criterio di active directory B2C di Azure. Fare riferimento a https://aka.ms/msal-net-b2c-specificities (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Imposta le attestazioni nella query. Usare quando l'amministratore di AAD ha abilitato l'accesso condizionale. L'acquisizione del token genererà un MsalUiRequiredException oggetto con il set di Claims proprietà. Ripetere l'acquisizione del token e usare questo valore nel WithClaims(String) metodo . Per https://aka.ms/msal-exceptions informazioni dettagliate, vedere https://aka.ms/msal-net-claim-challenge. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Imposta l'ID di correlazione da utilizzare nella richiesta di autenticazione. Usato per tenere traccia di una richiesta nei log dell'SDK e del servizio provider di identità. Se non è impostato, ne verrà generato uno casuale. (Ereditato da BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Obsoleti.
Imposta parametri di query aggiuntivi per la stringa di query nella richiesta di autenticazione HTTP. (Ereditato da BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Imposta parametri di query aggiuntivi per la stringa di query nella richiesta di autenticazione HTTP con il controllo sui parametri inclusi nella chiave della cache (Ereditato da BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Obsoleti.
Imposta parametri di query aggiuntivi per la stringa di query nella richiesta di autenticazione HTTP. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Aggiunge un parametro fmi_path alla richiesta. Modifica l'oggetto del token. |
| WithForceRefresh(Boolean) |
Specifica se l'applicazione client deve ignorare i token di accesso durante la lettura della cache dei token. I nuovi token verranno comunque scritti nella cache dei token dell'applicazione. Per impostazione predefinita, il token viene acquisito dalla cache dei token dell'applicazione (forceRefresh=false) |
| WithMtlsProofOfPossession() |
Specifica che il certificato fornito verrà usato per i token PoP con autenticazione mTLS (Mutual TLS). Per altre informazioni, vedere la documentazione proof-of-possession. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Obsoleti.
Usare WithAzureRegion nell'oggetto ConfidentialClientApplicationBuilder |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Obsoleti.
Modifica la richiesta di acquisizione del token in modo che il token acquisito sia un token di verifica del possesso (PoP), anziché un token di connessione. I token PoP sono simili ai token di connessione, ma sono associati alla richiesta HTTP e a una chiave crittografica, che MSAL può gestire in Windows. Fare riferimento a https://aka.ms/msal-net-pop (Ereditato da AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Specifica gli ambiti da richiedere. Questo metodo viene usato quando l'applicazione deve specificare gli ambiti necessari per chiamare un'API protetta. <Vedere>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</vedere> per altre informazioni su ambiti, autorizzazioni e consenso e <vedere>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</vedere> per informazioni su come creare ambiti per le applicazioni legacy usate per esporre le autorizzazioni OAuth2. (Ereditato da AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Applicabile solo alle applicazioni proprietarie, questo metodo consente anche di specificare se l'attestazione x5c deve essere inviata a Azure AD. L'invio di x5c consente agli sviluppatori di applicazioni di ottenere un semplice rollover dei certificati in Azure AD: questo metodo invierà la catena di certificati a Azure AD insieme alla richiesta di token, in modo che Azure AD possa usarlo per convalidare il nome soggetto in base a criteri di autorità di certificazione attendibili. In questo modo l'amministratore dell'applicazione viene salvato dalla necessità di gestire in modo esplicito il rollover del certificato (tramite il portale o l'operazione di PowerShell/CLI). Per informazioni dettagliate, vedere https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Modifica la richiesta per acquisire un token SHR (Signed HTTP Request) Proof-of-Possession (PoP), anziché un bearer. I token PoP SHR sono associati alla richiesta HTTP e a una chiave crittografica, gestita da MSAL in Windows. I token PoP SHR sono diversi dai token PoP mTLS, usati per l'autenticazione mTLS (Mutual TLS). Per informazioni dettagliate, vedere https://aka.ms/mtls-pop. (Ereditato da AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Esegue l'override dell'ID tenant specificato nell'autorità a livello di applicazione. Questa operazione mantiene l'host dell'autorità (ambiente). Se non è stata specificata un'autorità a livello di applicazione, l'impostazione predefinita usata è |
| WithTenantIdFromAuthority(Uri) |
Estrae l'ID tenant dall'URI dell'autorità fornita ed esegue l'override dell'ID tenant specificato nell'autorità a livello di applicazione. Questa operazione mantiene l'host dell'autorità (ambiente) fornito al generatore di applicazioni.
Se non è stata fornita un'autorità al generatore di applicazioni, questo metodo sostituirà l'ID tenant nell'autorità predefinita - |
Metodi di estensione
| Nome | Descrizione |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Interviene nella pipeline di richiesta eseguendo un delegato fornito dall'utente prima che MSAL effettui la richiesta del token. Il delegato può modificare il payload della richiesta aggiungendo o rimuovendo i parametri e le intestazioni del corpo. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Configura l'SDK per non recuperare un token dalla cache se corrisponde all'hash SHA256 del token configurato. Analogamente all'API WithForceRefresh(bool), ma invece di ignorare la cache per tutti i token, il bypass della cache si verifica solo per 1 token |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Specifica parametri aggiuntivi acquisiti dalle risposte di autenticazione da memorizzare nella cache con il token di accesso che normalmente non sono inclusi nell'oggetto cache. questi valori possono essere letti dal AdditionalResponseParameters parametro . |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Invia |
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Consente alle applicazioni client di fornire un'operazione di autenticazione personalizzata da usare nella richiesta di acquisizione del token. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Aggiunge una coppia chiave-valore alla chiave della cache dei token senza inviarla come parametro di query.
Usare questa opzione per partizionare i token memorizzati nella cache ,ad esempio isolando le sessioni di breve durata dalle sessioni regolari per lo stesso utente. Sia |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Specifica le attestazioni originate dal client da includere nella richiesta di token. A differenza WithClaims(String) di (per le richieste rilasciate dal server), i token acquisiti con attestazioni client vengono memorizzati nella cache e la voce della cache viene chiaveta sul valore delle attestazioni. Valori di attestazioni diversi producono voci di cache separate. Usare valori stabili e non dinamici per evitare la crescita della cache non associato. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Aggiungere parametri del corpo aggiuntivi alla richiesta di token. Questi parametri vengono aggiunti alla chiave della cache per associare questi parametri al token acquisito. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Aggiungere parametri del corpo aggiuntivi alla richiesta di token. Questi parametri vengono aggiunti alla chiave della cache per associare questi parametri al token acquisito. Funziona per i flussi client riservati (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Specifica attestazioni aggiuntive da includere nell'asserzione client. Queste attestazioni verranno unite con attestazioni predefinite quando viene generata l'asserzione client. In questo modo, le API di livello superiore, ad esempio Microsoft. Identity.Web fornisce attestazioni aggiuntive per l'asserzione client. Importante: i token sono associati alle attestazioni di asserzione client aggiuntive, che influiscono sulle ricerche nella cache. Si tratta di un'API di estendibilità e non deve essere usata direttamente dalle applicazioni. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Obsoleti.
Aggiunge altre intestazioni HTTP alla richiesta di token. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Aggiunge intestazioni HTTP aggiuntive alla richiesta di token. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Specifica un percorso FMI da utilizzare per l'asserzione client. In questo modo, le API di livello superiore come Id.Web forniscono credenziali sensibili a FMI. Importante: i token sono associati al percorso FMI delle credenziali, che influisce sulle ricerche nella cache. Si tratta di un'API di estendibilità e non deve essere usata dalle applicazioni. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Associa il token a una chiave nella cache. Le chiavi della cache L2 contengono l'ID chiave. Nessuna operazione di crittografia viene eseguita sul token. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Associa il token a una chiave nella cache. Nessuna operazione di crittografia viene eseguita sul token. |