AcquireTokenForClientParameterBuilder Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Generator für AcquireTokenForClient (verwendet in Clientanmeldeinformationsflüssen, in Daemonanwendungen). Siehe 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)- Vererbung
Methoden
| Name | Beschreibung |
|---|---|
| ExecuteAsync() |
Führt die Tokenanforderung asynchron aus. (Geerbt von BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Führt die Tokenanforderung asynchron aus, mit der Möglichkeit, die asynchrone Methode abzusagen. (Geerbt von AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Überprüft die Parameter des AcquireToken-Vorgangs. (Geerbt von AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Fügt eine bekannte Autorität hinzu, die einem ADFS-Server entspricht. Siehe https://aka.ms/msal-net-adfs. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Gibt ein Identitätsattribut an, das in die Tokenanforderung eingeschlossen werden soll. Die Attributwerte werden als Anspruch im Token "xms_attr" in den Zugriffstokenansprüchen zurückgegeben. Dies wird in der Regel mit FMI-Szenarien (Federated Managed Identity) verwendet. Beispiel-Attribut json: "{"sg1":"0000-00000-0001","sg2":["0000-0000-0002","0000-0000-00003","0000-0000-0000-0004"]}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Anmeldebenutzer anzugeben, die die Anmeldegruppe angeben (die Cloud ist die Azure öffentliche Cloud). Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Veraltet.
Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Anmeldebenutzern die Cloudinstanz und die Anmeldegruppe anzugeben. Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Benutzer aus einer einzigen Organisation (Einzelmandantenanwendung) anzumelden, die von ihrer Cloudinstanz und ihrer Mandanten-ID beschrieben wird. Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Benutzer aus einer einzelnen Organisation (Einzelmandantenanwendung) anzumelden, die von der Cloudinstanz und dem Domänennamen oder der Mandanten-ID beschrieben wird. Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Spezifische Autorität, für die das Token angefordert wird. Durch Übergeben eines anderen Werts als beim Anwendungskonstruktor wird die Auswahl auf einen bestimmten Mandanten beschränkt. Dadurch wird der konfigurierte Wert in der Anwendung nicht geändert. Dies gilt speziell für Anwendungen, die mehrere Konten verwalten (z. B. einen E-Mail-Client mit mehreren Postfächern). Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Benutzer aus einer einzelnen Organisation (Einzelmandantenanwendung) anzumelden, die durch ihre Mandanten-ID angegeben wird. Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Veraltet.
Wichtig: Verwenden Sie stattdessen WithTenantId oder WithTenantIdFromAuthority oder WithB2CAuthority für B2C-Behörden. Fügt der Anwendung eine bekannte Azure AD-Autorität hinzu, um Benutzer aus einer einzelnen Organisation (Einzelmandantenanwendung) anzumelden, die durch ihren Domänennamen beschrieben wird. Siehe https://aka.ms/msal-net-application-configuration. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Veraltet.
Verwenden Sie WithAzureRegion für das ConfidentialClientApplicationBuilder-Objekt |
| WithB2CAuthority(String) |
Fügt eine bekannte Autorität hinzu, die einer Azure AD B2C-Richtlinie entspricht. Siehe https://aka.ms/msal-net-b2c-specificities. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Legt Ansprüche in der Abfrage fest. Wird verwendet, wenn der AAD-Administrator bedingten Zugriff aktiviert hat. Das Abrufen des Tokens führt normalerweise zu einem MsalUiRequiredException Mit dem Claims Eigenschaftensatz. Wiederholen Sie den Tokenerwerb, und verwenden Sie diesen Wert in der WithClaims(String) Methode. Details sowie weitere Informationen finden https://aka.ms/msal-exceptionsSie https://aka.ms/msal-net-claim-challenge unter . (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Legt die Korrelations-ID fest, die in der Authentifizierungsanforderung verwendet werden soll. Wird verwendet, um eine Anforderung in den Protokollen des SDK und des Identitätsanbieterdiensts nachzuverfolgen. Wenn sie nicht festgelegt ist, wird ein zufälliges Generiert. (Geerbt von BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Veraltet.
Legt zusätzliche Abfrageparameter für die Abfragezeichenfolge in der HTTP-Authentifizierungsanforderung fest. (Geerbt von BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Legt zusätzliche Abfrageparameter für die Abfragezeichenfolge in der HTTP-Authentifizierungsanforderung fest, mit der Kontrolle, welche Parameter im Cacheschlüssel enthalten sind (Geerbt von BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Veraltet.
Legt zusätzliche Abfrageparameter für die Abfragezeichenfolge in der HTTP-Authentifizierungsanforderung fest. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Fügt der Anforderung einen fmi_path Parameter hinzu. Es ändert den Betreff des Tokens. |
| WithForceRefresh(Boolean) |
Gibt an, ob die Clientanwendung Zugriffstoken beim Lesen des Tokencaches ignorieren soll. Neue Token werden weiterhin in den Anwendungstokencache geschrieben. Standardmäßig wird das Token aus dem Anwendungstokencache (forceRefresh=false) übernommen. |
| WithMtlsProofOfPossession() |
Gibt an, dass das bereitgestellte Zertifikat für PoP-Token mit MTLS-Authentifizierung (Mutual TLS) verwendet wird. Weitere Informationen finden Sie in der Dokumentation zum Nachweis des Besitzes. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Veraltet.
Verwenden Sie WithAzureRegion für das ConfidentialClientApplicationBuilder-Objekt |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Veraltet.
Ändert die Tokenakquisitionsanforderung so, dass das erworbene Token ein Proof-of-Possession-Token (PoP) anstelle eines Bearertokens ist. PoP-Token ähneln Bearer-Token, sind aber an die HTTP-Anforderung und an einen kryptografischen Schlüssel gebunden, den MSAL auf Windows verwalten kann. Siehe https://aka.ms/msal-net-pop. (Geerbt von AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Gibt an, welche Bereiche angefordert werden sollen. Diese Methode wird verwendet, wenn Ihre Anwendung die Bereiche angeben muss, die zum Aufrufen einer geschützten API erforderlich sind. Weitere Informationen <zu Bereichen, Berechtigungen und Zustimmung>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent<> finden Sie unter</>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes<finden Sie unter/finden Sie unter/erfahren> Sie, wie Sie Bereiche für Ältere Anwendungen erstellen, die zum Verfügbarmachen von OAuth2-Berechtigungen verwendet wurden. (Geerbt von AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Diese Methode kann auch angeben, ob der x5c-Anspruch an Azure AD gesendet werden soll. Durch das Senden von x5c können Anwendungsentwickler ein einfaches Zertifikatrollover in Azure AD erzielen: Mit dieser Methode wird die Zertifikatkette zusammen mit der Tokenanforderung an Azure AD gesendet, sodass Azure AD diesen verwenden kann, um den Antragstellernamen basierend auf einer vertrauenswürdigen Ausstellerrichtlinie zu überprüfen. Dadurch wird der Anwendungsadministrator vor der expliziten Verwaltung des Zertifikatrollovers (entweder über das Portal oder über den PowerShell/CLI-Vorgang) gespeichert. Weitere Informationen finden Sie unter https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Ändert die Anforderung, ein SHR-Token (Signed HTTP Request, Proof-of-Possession) anstelle eines Bearers abzurufen. SHR-PoP-Token sind an die HTTP-Anforderung und an einen kryptografischen Schlüssel gebunden, den MSAL auf Windows verwaltet. SHR-PoP-Token unterscheiden sich von mTLS-PoP-Token, die für die MTLS-Authentifizierung (Mutual TLS) verwendet werden. Weitere Informationen finden Sie unter https://aka.ms/mtls-pop. (Geerbt von AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Überschreibt die mandanten-ID, die in der Autorität auf Anwendungsebene angegeben ist. Dieser Vorgang behält den Autoritätshost (Umgebung) bei. Wenn auf Anwendungsebene keine Autorität angegeben wurde, wird |
| WithTenantIdFromAuthority(Uri) |
Extrahiert die Mandanten-ID aus dem bereitgestellten Autoritäts-URI und überschreibt die mandanten-ID, die in der Autorität auf Anwendungsebene angegeben ist. Dieser Vorgang behält den Autoritätshost (Umgebung) bei, der für den Anwendungs-Generator bereitgestellt wird.
Wenn dem Anwendungs-Generator keine Autorität bereitgestellt wurde, ersetzt diese Methode die Mandanten-ID in der Standardautorität - |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Greift in die Anforderungspipeline ein, indem ein vom Benutzer bereitgestellter Delegat ausgeführt wird, bevor MSAL die Tokenanforderung vorgibt. Der Delegat kann die Anforderungsnutzlast ändern, indem Textkörperparameter und Header hinzugefügt oder entfernt werden. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Konfiguriert das SDK, um kein Token aus dem Cache abzurufen, wenn es mit dem SHA256-Hash des konfigurierten Tokens übereinstimmt. Ähnlich wie die WithForceRefresh(bool)-API, aber anstatt den Cache für alle Token zu umgehen, tritt die Cacheumgehung nur für 1 Token auf. |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Gibt zusätzliche Parameter an, die aus Authentifizierungsantworten abgerufen werden, die mit dem Zugriffstoken zwischengespeichert werden, die normalerweise nicht im Cacheobjekt enthalten sind. diese Werte können aus dem AdditionalResponseParameters Parameter gelesen werden. |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Sendet |
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Ermöglicht Clientanwendungen die Bereitstellung eines benutzerdefinierten Authentifizierungsvorgangs, der in der Tokenakquisitionsanforderung verwendet werden soll. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Fügt dem Tokencacheschlüssel ein Schlüssel-Wert-Paar hinzu, ohne es als Abfrageparameter zu senden.
Verwenden Sie dies, um zwischengespeicherte Token zu partitionieren (z. B. das Isolieren von kurzlebigen Sitzungen aus regulären Sitzungen für denselben Benutzer). Beide und |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Gibt clientbasierte Ansprüche an, die in die Tokenanforderung aufgenommen werden sollen. Im Gegensatz zu WithClaims(String) (für Server ausgegebene Anspruchsforderungen) werden mit Clientansprüchen erworbene Token zwischengespeichert , und der Cacheeintrag wird auf den Anspruchswert festgelegt. Unterschiedliche Anspruchswerte erzeugen separate Cacheeinträge. Verwenden Sie stabile, nicht dynamische Werte, um ein ungebundenes Cachewachstum zu vermeiden. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Fügen Sie der Tokenanforderung zusätzliche Textparameter hinzu. Diese Parameter werden dem Cacheschlüssel hinzugefügt, um diese Parameter dem erworbenen Token zuzuordnen. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Fügen Sie der Tokenanforderung zusätzliche Textparameter hinzu. Diese Parameter werden dem Cacheschlüssel hinzugefügt, um diese Parameter dem erworbenen Token zuzuordnen. Funktioniert für vertrauliche Clientflüsse (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Gibt zusätzliche Ansprüche an, die in die Client assertion aufgenommen werden sollen. Diese Ansprüche werden mit Standardansprüchen zusammengeführt, wenn die Client assertion generiert wird. Auf diese Weise können APIs auf höherer Ebene wie Microsoft. Identity.Web stellt zusätzliche Ansprüche für die Client assertion bereit. Wichtig: Token sind den zusätzlichen Client assertionsansprüchen zugeordnet, die sich auf Cache-Nachschlagevorgänge auswirken. Dies ist eine Erweiterbarkeits-API und sollte nicht direkt von Anwendungen verwendet werden. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Veraltet.
Fügt der Tokenanforderung zusätzliche HTTP-Header hinzu. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Fügt der Tokenanforderung zusätzliche HTTP-Header hinzu. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Gibt einen FMI-Pfad an, der für die Client assertion verwendet werden soll. Auf diese Weise können APIs auf höherer Ebene wie Id.Web Anmeldeinformationen bereitstellen, die von FMI vertraulich sind. Wichtig: Token sind dem FMI-Pfad für Anmeldeinformationen zugeordnet, was sich auf Cache-Nachschlagevorgänge auswirkt. Dies ist eine Erweiterbarkeits-API und sollte nicht von Anwendungen verwendet werden. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Bindet das Token an einen Schlüssel im Cache. L2-Cacheschlüssel enthalten die Schlüssel-ID. Für das Token werden keine kryptografischen Vorgänge ausgeführt. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Bindet das Token an einen Schlüssel im Cache. Für das Token werden keine kryptografischen Vorgänge ausgeführt. |