TokenAcquisitionOptions 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.
Übergebene Optionen zum Erstellen des Tokenakquisitionsobjekts, das msAL .NET aufruft.
public class TokenAcquisitionOptions : Microsoft.Identity.Abstractions.AcquireTokenOptions
type TokenAcquisitionOptions = class
inherit AcquireTokenOptions
Public Class TokenAcquisitionOptions
Inherits AcquireTokenOptions
- Vererbung
Konstruktoren
| Name | Beschreibung |
|---|---|
| TokenAcquisitionOptions() |
Übergebene Optionen zum Erstellen des Tokenakquisitionsobjekts, das msAL .NET aufruft. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| AuthenticationOptionsName |
Ruft den Namen der Optionen ab, die die vertrauliche Clientanwendung beschreiben (ClientID, Region, Autorität, Clientanmeldeinformationen). In ASP.NET Core entspricht der Name der Authentifizierungsoptionen dem Authentifizierungsschema. (Geerbt von AcquireTokenOptions) |
| CancellationToken |
Abbruchtoken, das beim Aufrufen der Tokenakquisitionsmethoden verwendet werden soll. |
| Claims |
Eine Zeichenfolge mit einem oder mehreren Ansprüchen, die angefordert werden sollen. Es ist ein JSON-Blob (codiert oder nicht) Normalerweise mit bedingtem Zugriff verwendet. Es empfängt das Claims-Mitglied der UiRequiredException. Sie kann auch verwendet werden, um bestimmte optionale Ansprüche anzufordern, und für Ca Auth-Kontext (Geerbt von AcquireTokenOptions) |
| CorrelationId |
Legt die Korrelations-ID fest, die in der Anforderung an den STS-Endpunkt "/token" verwendet werden soll. (Geerbt von AcquireTokenOptions) |
| ExtraHeadersParameters |
Übergebene Optionen zum Erstellen des Tokenakquisitionsobjekts, das msAL .NET aufruft. (Geerbt von AcquireTokenOptions) |
| ExtraParameters |
Ein Eigenschaftenbehälter, der für die Erweiterbarkeit verwendet wird. (Geerbt von AcquireTokenOptions) |
| ExtraQueryParameters |
Legt Abfrageparameter für die Abfragezeichenfolge in der HTTP-Anforderung auf den Endpunkt "/token" fest. (Geerbt von AcquireTokenOptions) |
| FmiPath |
FMI-Unterpfad (Federated Managed Identity). (Geerbt von AcquireTokenOptions) |
| ForceRefresh |
Gibt an, ob die Tokenanforderung das Zugriffstoken im Tokencache ignoriert und versucht, ein neues Zugriffstoken abzurufen.
Wenn |
| LongRunningWebApiSessionKey |
Schlüssel, der für lange ausgeführte Web-APIs verwendet wird, die nachgeschaltete Web-APIs im Namen des Benutzers aufrufen müssen. Kann null sein, wenn Sie keine lange ausgeführte Web-API entwickeln, LongRunningWebApiSessionKeyAuto wenn der Token-Acquirer einen Sitzungsschlüssel für Sie zuweisen soll, oder ihre eigene Zeichenfolge, wenn Sie die Sitzung externen Informationen zuordnen möchten (z. B. eine Microsoft Graph Hook-ID). (Geerbt von AcquireTokenOptions) |
| ManagedIdentity |
Wenn ManagedIdentity diese Einstellung festgelegt ist, verwendet die Anwendung eine verwaltete Identität anstelle von Clientanmeldeinformationen, um ein App-Token abzurufen. Wenn Sie eine vom System zugewiesene Identität verwenden möchten, lassen Sie einfach NULL.UserAssignedClientId Um eine vom Benutzer zugewiesene Identität zu verwenden, legen Sie diese auf die Client-ID der vom Benutzer zugewiesenen Identität fest UserAssignedClientId , die Sie verwenden möchten. Die Verwendung einer der formenverwalteten Identität erfordert, dass die Anwendung auf Azure bereitgestellt wird und die verwaltete Identität konfiguriert wird. Weitere Informationen finden Sie in den verwalteten Identitäten für Azure Dokumentation. (Geerbt von AcquireTokenOptions) |
| PopClaim |
Geben Sie zusätzlich zum PopPublicKeyPopClaim bei Bedarf in bestimmten POP-Protokollen den PopClaim an. (Geerbt von AcquireTokenOptions) |
| PoPConfiguration |
Ä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 verwalten kann. Siehe https://aka.ms/msal-net-pop. |
| PopPublicKey |
Ä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 verwalten kann. Siehe https://aka.ms/msal-net-pop. (Geerbt von AcquireTokenOptions) |
| Tenant |
(Microsoft Identitätsspezifisch) Ermöglicht das Überschreiben des Mandanten/Kontos, für das ein Token abgerufen werden soll. Dies ist bei Mehrinstanzen-Apps in den Fällen nützlich, in denen ein bestimmtes Benutzerkonto ein Gast in anderen Mandanten ist und Sie Token für einen bestimmten Mandanten erwerben möchten. (Geerbt von AcquireTokenOptions) |
| UserFlow |
(Microsoft Identitätsspezifisch) Bei AzureAD B2C wird ein bestimmter Benutzerfluss verwendet. (Geerbt von AcquireTokenOptions) |
Methoden
| Name | Beschreibung |
|---|---|
| Clone() |
Klonen Sie die Optionen (um sie außer Kraft zu setzen). |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| WithCachePartitionKeys(TokenAcquisitionOptions, IDictionary<String,String>) |
Legt Schlüssel-Wert-Paare der Cachepartition für die Optionen fest. Bei Festlegung enthält die Tokencachesuche und -speicherung diese Komponenten und isoliert zwischengespeicherte Token aus Einträgen, die unterschiedliche (oder keine) Partitionsschlüssel aufweisen. |
| WithClientAssertion(AcquireTokenOptions, String) |
Betrachten Sie die Client-Assertion für die Tokenanforderung. |
| WithExtraBodyParameters(AcquireTokenOptions, IDictionary<String,String>) |
Fügt der Tokenakquisitionsanforderung zusätzliche Textparameter hinzu. Parameter werden in alle vorhandenen zusätzlichen Textparameterwörterbücher zusammengeführt, sodass dies mit anderen Erweiterungen zusammengesetzt werden kann, die auch Textparameter hinzufügen. |