AcquireTokenInteractiveParameterBuilder 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.
Byggare för en interaktiv tokenbegäran. Se https://aka.ms/msal-net-acquire-token-interactively
public sealed class AcquireTokenInteractiveParameterBuilder : Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder>type AcquireTokenInteractiveParameterBuilder = class
inherit AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenInteractiveParameterBuilder>Public NotInheritable Class AcquireTokenInteractiveParameterBuilder
Inherits AbstractPublicClientAcquireTokenParameterBuilder(Of AcquireTokenInteractiveParameterBuilder)- Arv
-
AcquireTokenInteractiveParameterBuilder
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 AbstractPublicClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Verifierar parametrarna för åtgärden AcquireToken. (Ärvd från BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithAccount(IAccount) |
Anger det konto som token ska hämtas för. Den här metoden är ömsesidigt uteslutande med WithLoginHint(String). Om båda används genereras ett undantag |
| 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>) |
| 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 en enskild klientorganisation) som beskrivs av dess domännamn. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractAcquireTokenParameterBuilder<T>) |
| 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>) |
| WithEmbeddedWebViewOptions(EmbeddedWebViewOptions) |
Anger alternativ för att använda den inbäddade webbvyn för interaktiv autentisering. |
| 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>) |
| WithExtraScopesToConsent(IEnumerable<String>) |
Byggare för en interaktiv tokenbegäran. Se https://aka.ms/msal-net-acquire-token-interactively |
| WithLoginHint(String) |
|
| WithParentActivityOrWindow(IntPtr) |
Anger en referens till IntPtr till ett fönster som utlöser webbläsaren som ska visas. Används för att centrera webbläsaren som dyker upp i det här fönstret. Mitten av skärmen eller förgrundsappen om ett värde har konfigurerats. |
| WithParentActivityOrWindow(Object) |
Anger en referens till ViewController (om du använder iOS), Aktivitet (om du använder Android) IWin32Window eller IntPtr (om du använder .Net Framework). Används för att anropa webbläsaren. |
| WithPrompt(Prompt) |
Anger vad den interaktiva upplevelsen är för användaren. |
| WithProofOfPossession(String, HttpMethod, Uri) |
Ä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. Observera att endast värd- och sökvägsdelarna i begärande-URI:n är bundna. Se https://aka.ms/msal-net-pop |
| 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>) |
| WithSystemWebViewOptions(SystemWebViewOptions) |
Anger alternativ för att använda systemoperativsystemets webbläsare som hanterar interaktiv autentisering. |
| 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 - |
| WithUseEmbeddedWebView(Boolean) |
Anger om det offentliga klientprogrammet ska använda en inbäddad webbläsare eller systemets standardwebbläsare. Om asynkron meddelandekö (WAM, Authenticator, Company Portal) har konfigurerats används den här inställningen endast när asynkron meddelandekö inte är installerad. På .NET, inklusive net8-windows, måste apputvecklare referera till Microsoft. Identity.Client.Desktop och anropa PublicClientApplicationBuilder.WithDesktopFeatures() för att aktivera den inbäddade webbläsaren. |
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 |
| 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 . |
| 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 |
| WithCustomWebUi(AcquireTokenInteractiveParameterBuilder, ICustomWebUi) |
Tilläggsmetod som aktiverar MSAL.NET utökare för offentliga klientprogram för att ange ett anpassat webbgränssnitt som låter användaren logga in med Azure AD, presentera medgivande om det behövs och få tillbaka auktoriseringskoden |
| 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<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Binder token till en nyckel i cacheminnet. Inga kryptografiska åtgärder utförs på token. |
| WithSSHCertificateAuthenticationScheme(AcquireTokenInteractiveParameterBuilder, String, String) |
Instruerar AAD att returnera ett SSH-certifikat i stället för en ägartoken. SSH-certifikatet (inte samma som offentligt/privat nyckelpar som används av SSH) kan användas för att på ett säkert sätt distribuera en offentlig SSH-nyckel till en dator. Se https://aka.ms/msal-net-ssh för mer information. |