AcquireTokenForClientParameterBuilder Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Builder för AcquireTokenForClient (används i klientautentiseringsflöden i daemonprogram). Se 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)- Arv
Metoder
| Name | Description |
|---|---|
| ExecuteAsync() |
Kör tokenbegäran asynkront. (Ärvd från BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Kör tokenbegäran asynkront, med möjlighet att avbryta den asynkrona metoden. (Ärvd från AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Verifierar parametrarna för åtgärden AcquireToken. (Ärvd från AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Lägger till en känd utfärdare som motsvarar en ADFS-server. Se även https://aka.ms/msal-net-adfs. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Anger ett identitetsattribut som ska inkluderas i tokenbegäran. Attributvärdena returneras som ett anspråk i token med namnet "xms_attr" i anspråken för åtkomsttoken. Detta används vanligtvis med FMI-scenarier (federerad hanterad identitet). Exempelattribut json: "{"sg1":"0000-00000-0001","sg2":["0000-00000-0002","0000-00000-0003","0000-0000-0004"]}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Lägger till en känd Azure AD-utfärdare till programmet för inloggningsanvändare som anger inloggningspubliken (molnet är Azure offentliga molnet). Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Föråldrad.
Lägger till en känd Azure AD-utfärdare i programmet för inloggningsanvändare som anger molninstansen och inloggningspubliken. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program för enskild klientorganisation) som beskrivs av dess molninstans och dess klient-ID. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program för enskild klientorganisation) som beskrivs av dess molninstans och dess domännamn eller klient-ID. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Specifik utfärdare som token begärs för. Om du skickar ett annat värde än det som konfigurerats i programkonstruktorn begränsas markeringen till en specifik klientorganisation. Detta ändrar inte det konfigurerade värdet i programmet. Detta är specifikt för program som hanterar flera konton (som en e-postklient med flera postlådor). Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program för enskild klientorganisation) som anges av dess klientorganisations-ID. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Föråldrad.
Viktigt: Använd WithTenantId eller WithTenantIdFromAuthority i stället, eller WithB2CAuthority för B2C-myndigheter. Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program för enskild klientorganisation) som beskrivs av dess domännamn. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Föråldrad.
Använd WithAzureRegion på objektet ConfidentialClientApplicationBuilder |
| WithB2CAuthority(String) |
Lägger till en känd utfärdare som motsvarar en Azure AD B2C-princip. Se https://aka.ms/msal-net-b2c-specificities (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Anger anspråk i frågan. Använd när AAD-administratören har aktiverat villkorlig åtkomst. Om du hämtar token normalt resulterar det i en MsalUiRequiredException med egenskapsuppsättningen Claims . Försök att förvärva token igen och använd det här värdet i WithClaims(String) -metoden. Se https://aka.ms/msal-exceptions för mer information samt https://aka.ms/msal-net-claim-challenge. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Anger korrelations-ID som ska användas i autentiseringsbegäran. Används för att spåra en begäran i loggarna för både SDK och identitetsprovidertjänsten. Om den inte anges genereras en slumpmässig. (Ärvd från BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Föråldrad.
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran. (Ärvd från BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran med kontroll över vilka parametrar som ingår i cachenyckeln (Ärvd från BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Föråldrad.
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Lägger till en fmi_path parameter i begäran. Den ändrar tokens ämne. |
| WithForceRefresh(Boolean) |
Anger om klientprogrammet ska ignorera åtkomsttoken när tokencachen läss. Nya token skrivs fortfarande till cacheminnet för programtoken. Som standard hämtas token från cacheminnet för programtoken (forceRefresh=false) |
| WithMtlsProofOfPossession() |
Anger att det angivna certifikatet ska användas för PoP-token med mTLS-autentisering (Ömsesidig TLS). Mer information finns i dokumentationen om innehavsbevis. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Föråldrad.
Använd WithAzureRegion på objektet ConfidentialClientApplicationBuilder |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Föråldrad.
Ändrar begäran om tokenförvärv så att den förvärvade token är en PoP (Proof-of-Possession Token) i stället för en Bearer-token. PoP-token liknar Bearer-token, men är bundna till HTTP-begäran och till en kryptografisk nyckel som MSAL kan hantera på Windows. Se https://aka.ms/msal-net-pop (Ärvd från AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Anger vilka omfång som ska begäras. Den här metoden används när ditt program behöver ange de omfång som behövs för att anropa ett skyddat API. >https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent<Mer <information om omfång, behörigheter och medgivande>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes<< finns i/>se> för att lära dig hur du skapar omfång för äldre program som används för att exponera OAuth2-behörigheter. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Den här metoden gäller endast för program från första part och tillåter även att du anger om x5c-anspråket ska skickas till Azure AD. Genom att skicka x5c kan programutvecklare enkelt distribuera certifikat i Azure AD: Den här metoden skickar certifikatkedjan till Azure AD tillsammans med tokenbegäran, så att Azure AD kan använda den för att verifiera ämnesnamnet baserat på en princip för betrodd utfärdare. Detta sparar programadministratören från behovet av att uttryckligen hantera certifikatet (antingen via portalen eller PowerShell/CLI-åtgärden). Mer information finns i https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Ändrar begäran om att hämta en signerad TOKEN för HTTP-begäran (SHR) Proof-of-Possession (PoP) i stället för en ägartoken. SHR PoP-token är bundna till HTTP-begäran och till en kryptografisk nyckel som MSAL hanterar på Windows. SHR PoP-token skiljer sig från mTLS PoP-token, som används för ömsesidig TLS-autentisering (mTLS). Se https://aka.ms/mtls-pop för mer information. (Ärvd från AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Åsidosätter klientorganisations-ID:t som anges i utfärdaren på programnivå. Den här åtgärden bevarar utfärdarvärden (miljön). Om en utfärdare inte har angetts på programnivå är |
| WithTenantIdFromAuthority(Uri) |
Extraherar klientorganisations-ID:t från den angivna utfärdarens URI och åsidosätter klientorganisations-ID:t som anges i utfärdaren på programnivå. Den här åtgärden bevarar den utfärdarvärd (miljö) som tillhandahålls till programverktyget.
Om en utfärdare inte har angetts för programverktyget ersätter den här metoden klientorganisations-ID:t i standardutfärdaren - |
Tilläggsmetoder
| Name | Description |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Ingriper i begärandepipelinen genom att köra ett användartillhandagivet ombud innan MSAL gör tokenbegäran. Ombudet kan ändra nyttolasten för begäran genom att lägga till eller ta bort brödtextparametrar och rubriker. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Konfigurerar SDK för att inte hämta en token från cacheminnet om den matchar SHA256-hashen för den konfigurerade token. Liknar WithForceRefresh(bool) API, men i stället för att kringgå cachen för alla token sker cache bypass endast för 1 token |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Anger ytterligare parametrar som hämtas från autentiseringssvar som ska cachelagras med den åtkomsttoken som normalt inte ingår i cacheobjektet. dessa värden kan läsas från parametern AdditionalResponseParameters . |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Skickar |
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Gör det möjligt för klientprogram att tillhandahålla en anpassad autentiseringsåtgärd som ska användas i begäran om tokenförvärv. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Lägger till ett nyckel/värde-par i tokencachenyckeln utan att skicka det som en frågeparameter.
Använd detta för att partitionera cachelagrade token (t.ex. isolera kortvariga sessioner från regelbundna sessioner för samma användare). Både |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Anger klientbaserade anspråk som ska inkluderas i tokenbegäran. Till skillnad från WithClaims(String) (för servertilldelade anspråksutmaningar ) cachelagras token som hämtas med klientanspråk och cacheposten är nyckelad på anspråksvärdet. Olika anspråksvärden skapar separata cacheposter. Använd stabila, icke-dynamiska värden för att undvika obundna cachetillväxt. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Lägg till extra brödtextparametrar i tokenbegäran. Dessa parametrar läggs till i cachenyckeln för att associera dessa parametrar med den förvärvade token. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Lägg till extra brödtextparametrar i tokenbegäran. Dessa parametrar läggs till i cachenyckeln för att associera dessa parametrar med den förvärvade token. Fungerar för konfidentiella klientflöden (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Anger extra anspråk som ska ingå i klientkontroll. Dessa anspråk sammanfogas med standardanspråk när klientkontroll genereras. Detta gör att API:er på högre nivå kan Microsoft. Identity.Web tillhandahåller ytterligare anspråk för klientkontroll. Viktigt: token är associerade med de extra klientkontrollanspråken, vilket påverkar cachesökningar. Det här är ett utöknings-API och bör inte användas direkt av program. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Föråldrad.
Lägger till ytterligare Http-huvuden i tokenbegäran. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Lägger till ytterligare HTTP-huvuden i tokenbegäran. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Anger en FMI-sökväg som ska användas för klientkontroll. På så sätt kan API:er på högre nivå som Id.Web ange autentiseringsuppgifter som är FMI-känsliga. Viktigt: token är associerade med FMI-sökvägen för autentiseringsuppgifter, vilket påverkar cachesökningar Detta är ett utöknings-API och bör inte användas av program. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Binder token till en nyckel i cacheminnet. L2-cachenycklar innehåller nyckel-ID:t. Inga kryptografiska åtgärder utförs på token. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Binder token till en nyckel i cacheminnet. Inga kryptografiska åtgärder utförs på token. |