AcquireTokenWithDeviceCodeParameterBuilder 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.
Parameterverktyget för åtgärden AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>) . Se https://aka.ms/msal-net-device-code-flow
public sealed class AcquireTokenWithDeviceCodeParameterBuilder : Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder>type AcquireTokenWithDeviceCodeParameterBuilder = class
inherit AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenWithDeviceCodeParameterBuilder>Public NotInheritable Class AcquireTokenWithDeviceCodeParameterBuilder
Inherits AbstractPublicClientAcquireTokenParameterBuilder(Of AcquireTokenWithDeviceCodeParameterBuilder)- Arv
-
AcquireTokenWithDeviceCodeParameterBuilder
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>) |
| WithAdfsAuthority(String, Boolean) |
Föråldrad.
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>) |
| WithDeviceCodeResultCallback(Func<DeviceCodeResult,Task>) |
Anger återanropsdelegaten så att programmet kan interagera med användaren för att dirigera dem att autentisera (till en specifik URL, med en kod) |
| 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>) |
| 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. <Mer >https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent<information om omfång, behörigheter och medgivande>< finns i/>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes<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>) |
| 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 |
| 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, Boolean) |
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 |
| 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 åtkomsttoken (t.ex. isolera kortvariga sessioner från vanliga sessioner för samma användare). Både |
| 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. |
| WithOtelTagsEnricher<T>(AbstractAcquireTokenParameterBuilder<T>, Action<ExecutionResult,IList<KeyValuePair<String,Object>>>) |
Registrerar ett ombud som lägger till ytterligare taggar (dimensioner) i OpenTelemetry-måtten som MSAL genererar för det här tokenförvärvet. Ombudet anropas medan MSAL registrerar sina mått och tar emot ExecutionResult förvärvet (som indikerar lyckat eller misslyckat resultat eller undantag) tillsammans med en föränderlig lista med taggar. Taggar som läggs till i listan är kopplade till varje mått som registrerats för begäran. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Binder token till en nyckel i cacheminnet. Inga kryptografiska åtgärder utförs på token. |