AcquireTokenForClientParameterBuilder Klas
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Builder voor AcquireTokenForClient (gebruikt in clientreferentiestromen, in daemon-toepassingen). Zie 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)- Overname
Methoden
| Name | Description |
|---|---|
| ExecuteAsync() |
Hiermee wordt de tokenaanvraag asynchroon uitgevoerd. (Overgenomen van BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Hiermee wordt de tokenaanvraag asynchroon uitgevoerd, met de mogelijkheid om de asynchrone methode te annuleren. (Overgenomen van AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Valideert de parameters van de AcquireToken-bewerking. (Overgenomen van AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Hiermee voegt u een bekende instantie toe die overeenkomt met een ADFS-server. Zie https://aka.ms/msal-net-adfs. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Hiermee geeft u een identiteitskenkenmerk op dat moet worden opgenomen in de tokenaanvraag. De kenmerkwaarden worden geretourneerd als een claim in het token met de naam 'xms_attr' in de toegangstokenclaims. Dit wordt meestal gebruikt met FMI-scenario's (Federatieve beheerde identiteit). Voorbeeld van kenmerk json: {"sg1":"0000-00000-00001","sg2":["0000-00000-00002","00000-0000-00003","0000-00000-0004"]}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden die de aanmeldingsdoelgroep opgeven (de cloud is de Azure openbare cloud). Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Verouderd.
Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden die het cloudexemplaren en de aanmeldingsdoelgroep opgeven. Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden vanuit één organisatie (één tenanttoepassing) die wordt beschreven door het cloudexemplaren en de tenant-id. Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden vanuit één organisatie (één tenanttoepassing) die wordt beschreven door het cloudexemplaren en de domeinnaam of tenant-id. Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Specifieke instantie waarvoor het token wordt aangevraagd. Als u een andere waarde doorgeeft dan is geconfigureerd bij de toepassingsconstructor, wordt de selectie beperkt tot een specifieke tenant. Hiermee wordt de geconfigureerde waarde in de toepassing niet gewijzigd. Dit is specifiek voor toepassingen die verschillende accounts beheren (zoals een e-mailclient met verschillende postvakken). Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden vanuit één organisatie (één tenanttoepassing) die is opgegeven door de tenant-id. Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Verouderd.
Belangrijk: gebruik in plaats daarvan WithTenantId of WithTenantIdFromAuthority of WithB2CAuthority voor B2C-instanties. Voegt een bekende Azure AD-instantie toe aan de toepassing om gebruikers aan te melden vanuit één organisatie (één tenanttoepassing) die wordt beschreven door de domeinnaam. Zie https://aka.ms/msal-net-application-configuration. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Verouderd.
Gebruik WithAzureRegion op het object ConfidentialClientApplicationBuilder |
| WithB2CAuthority(String) |
Voegt een bekende instantie toe die overeenkomt met een Azure AD B2C-beleid. Zie https://aka.ms/msal-net-b2c-specificities (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Hiermee stelt u claims in de query in. Gebruik deze optie wanneer de AAD-beheerder voorwaardelijke toegang heeft ingeschakeld. Het verkrijgen van het token resulteert normaal gesproken in een MsalUiRequiredException met de Claims eigenschappenset. Probeer het token opnieuw op te halen en gebruik deze waarde in de WithClaims(String) methode. Zie https://aka.ms/msal-exceptions voor meer informatie en https://aka.ms/msal-net-claim-challenge. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Hiermee stelt u de correlatie-id in die moet worden gebruikt in de verificatieaanvraag. Wordt gebruikt voor het bijhouden van een aanvraag in de logboeken van zowel de SDK als de Identity Provider-service. Als deze niet is ingesteld, wordt er een willekeurige gegenereerd. (Overgenomen van BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Verouderd.
Hiermee stelt u extra queryparameters in voor de querytekenreeks in de HTTP-verificatieaanvraag. (Overgenomen van BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Hiermee stelt u extra queryparameters voor de queryreeks in de HTTP-verificatieaanvraag in met controle over welke parameters zijn opgenomen in de cachesleutel (Overgenomen van BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Verouderd.
Hiermee stelt u extra queryparameters in voor de querytekenreeks in de HTTP-verificatieaanvraag. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Hiermee voegt u een fmi_path parameter toe aan de aanvraag. Het onderwerp van het token wordt gewijzigd. |
| WithForceRefresh(Boolean) |
Hiermee geeft u op of de clienttoepassing toegangstokens moet negeren bij het lezen van de tokencache. Nieuwe tokens worden nog steeds naar de cache van het toepassingstoken geschreven. Het token wordt standaard opgehaald uit de cache van het toepassingstoken (forceRefresh=false) |
| WithMtlsProofOfPossession() |
Hiermee geeft u op dat het opgegeven certificaat wordt gebruikt voor PoP-tokens met mTLS-verificatie (Wederzijdse TLS). Raadpleeg de documentatie over Proof-of-Possession voor meer informatie. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Verouderd.
Gebruik WithAzureRegion op het object ConfidentialClientApplicationBuilder |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Verouderd.
Wijzigt de aanvraag voor tokenverwerving zodat het verkregen token een Proof-of-Possession-token (PoP) is in plaats van een Bearer-token. PoP-tokens zijn vergelijkbaar met Bearer-tokens, maar zijn gebonden aan de HTTP-aanvraag en aan een cryptografische sleutel die MSAL op Windows kan beheren. Zie https://aka.ms/msal-net-pop (Overgenomen van AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Hiermee geeft u op welke bereiken moeten worden aangevraagd. Deze methode wordt gebruikt wanneer uw toepassing de bereiken moet opgeven die nodig zijn om een beveiligde API aan te roepen. Zie</zie>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent< voor> meer informatie over bereiken, machtigingen en toestemming en <zie/zie>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes<> voor meer informatie over het maken van bereiken voor verouderde toepassingen die worden gebruikt om OAuth2-machtigingen beschikbaar te maken. (Overgenomen van AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Alleen van toepassing op toepassingen van derden, met deze methode kunt u ook opgeven of de x5c-claim moet worden verzonden naar Azure AD. Door x5c te verzenden, kunnen toepassingsontwikkelaars eenvoudig certificaten in Azure AD implementeren: met deze methode wordt de certificaatketen naar Azure AD verzonden, samen met de tokenaanvraag, zodat Azure AD deze kan gebruiken om de onderwerpnaam te valideren op basis van een vertrouwd uitgeversbeleid. Hiermee slaat u de toepassingsbeheerder op uit de noodzaak om de certificaatrollover expliciet te beheren (via de portal of powerShell/CLI-bewerking). Zie voor meer informatie https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Hiermee wijzigt u de aanvraag voor het verkrijgen van een ondertekend SHR-token (Proof-of-Possession) van een HTTP-aanvraag (SHR) in plaats van een Bearer. SHR PoP-tokens zijn gebonden aan de HTTP-aanvraag en aan een cryptografische sleutel die MSAL beheert op Windows. SHR PoP-tokens verschillen van mTLS PoP-tokens, die worden gebruikt voor wederzijdse TLS-verificatie (mTLS). Zie https://aka.ms/mtls-pop voor meer informatie. (Overgenomen van AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Overschrijft de tenant-id die is opgegeven in de instantie op toepassingsniveau. Met deze bewerking blijft de instantiehost (omgeving) behouden. Als een instantie niet is opgegeven op toepassingsniveau, wordt |
| WithTenantIdFromAuthority(Uri) |
Extraheert de tenant-id van de opgegeven instantie-URI en overschrijft de tenant-id die is opgegeven in de instantie op toepassingsniveau. Met deze bewerking blijft de instantiehost (omgeving) behouden die aan de opbouwfunctie voor toepassingen is verstrekt.
Als er geen instantie is verstrekt aan de opbouwfunctie voor toepassingen, vervangt deze methode de tenant-id in de standaardinstantie - |
Extensiemethoden
| Name | Description |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Grijpt in de aanvraagpijplijn in door een door de gebruiker opgegeven gemachtigde uit te voeren voordat MSAL de tokenaanvraag doet. De gedelegeerde kan de nettolading van de aanvraag wijzigen door hoofdtekstparameters en headers toe te voegen of te verwijderen. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Hiermee configureert u de SDK zodanig dat er geen token uit de cache wordt opgehaald als het overeenkomt met de SHA256-hash van het geconfigureerde token. Vergelijkbaar met de Api van WithForceRefresh(bool), maar in plaats van de cache voor alle tokens te omzeilen, vindt de cache-bypass alleen plaats voor 1 token |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Hiermee geeft u aanvullende parameters op die zijn verkregen uit verificatiereacties die in de cache moeten worden opgeslagen met het toegangstoken dat normaal gesproken niet is opgenomen in het cacheobject. deze waarden kunnen worden gelezen uit de AdditionalResponseParameters parameter. |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Verzendt |
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Hiermee kunnen clienttoepassingen een aangepaste verificatiebewerking bieden die kan worden gebruikt in de aanvraag voor het verkrijgen van tokens. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Voegt een sleutel-waardepaar toe aan de tokencachesleutel zonder deze als queryparameter te verzenden.
Gebruik dit om tokens in de cache te partitioneren (bijvoorbeeld het isoleren van kortdurende sessies van gewone sessies voor dezelfde gebruiker). Beide |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Hiermee geeft u client-afkomstige claims op die moeten worden opgenomen in de tokenaanvraag. In tegenstelling tot WithClaims(String) (voor door de server uitgegeven claims) worden tokens die zijn verkregen met clientclaims in de cache opgeslagen en wordt de cachevermelding op de claimwaarde opgegeven. Verschillende claimwaarden produceren afzonderlijke cachevermeldingen. Gebruik stabiele, niet-dynamische waarden om niet-gebonden cachegroei te voorkomen. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Voeg extra hoofdtekstparameters toe aan de tokenaanvraag. Deze parameters worden toegevoegd aan de cachesleutel om deze parameters te koppelen aan het verkregen token. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Voeg extra hoofdtekstparameters toe aan de tokenaanvraag. Deze parameters worden toegevoegd aan de cachesleutel om deze parameters te koppelen aan het verkregen token. Werkt voor vertrouwelijke clientstromen (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Hiermee geeft u extra claims die moeten worden opgenomen in de clientverklaring. Deze claims worden samengevoegd met standaardclaims wanneer de clientbevestiging wordt gegenereerd. Hierdoor kunnen API's op een hoger niveau, zoals Microsoft. Identity.Web biedt aanvullende claims voor de clientverklaring. Belangrijk: tokens zijn gekoppeld aan de extra clientclaims, wat van invloed is op cachezoekacties. Dit is een uitbreidbaarheids-API en mag niet rechtstreeks door toepassingen worden gebruikt. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Verouderd.
Voegt extra HTTP-headers toe aan de tokenaanvraag. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Voegt extra HTTP-headers toe aan de tokenaanvraag. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Hiermee geeft u een FMI-pad moet worden gebruikt voor de clientverklaring. Hierdoor kunnen API's op een hoger niveau, zoals Id.Web, referenties opgeven die FMI-gevoelig zijn. Belangrijk: tokens zijn gekoppeld aan het FMI-referentiepad, wat van invloed is op cachezoekacties. Dit is een uitbreidbaarheids-API en mag niet worden gebruikt door toepassingen. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Verbindt het token met een sleutel in de cache. L2-cachesleutels bevatten de sleutel-id. Er worden geen cryptografische bewerkingen uitgevoerd op het token. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Verbindt het token met een sleutel in de cache. Er worden geen cryptografische bewerkingen uitgevoerd op het token. |