Sprache

MicrosoftIdentityMessageHandlerOptions Klasse

Definition

Namespace:
Microsoft.Identity.Web
Assembly:
Microsoft.Identity.Web.TokenAcquisition.dll
Paket:
Microsoft.Identity.Web.TokenAcquisition v4.16.1

Konfigurationsoptionen für MicrosoftIdentityMessageHandler die Authentifizierung. Erbt von AuthorizationHeaderProviderOptions der Kompatibilität mit vorhandenen Erweiterungsmethoden wie WithAgentIdentity() z. B. und WithUserAgentIdentity().

public class MicrosoftIdentityMessageHandlerOptions : Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions
type MicrosoftIdentityMessageHandlerOptions = class
    inherit AuthorizationHeaderProviderOptions
Public Class MicrosoftIdentityMessageHandlerOptions
Inherits AuthorizationHeaderProviderOptions
Vererbung
Object
AuthorizationHeaderProviderOptions
MicrosoftIdentityMessageHandlerOptions

Beispiele

Grundlegende Verwendung mit Bereichen:

var options = new MicrosoftIdentityMessageHandlerOptions
{
    Scopes = { "https://graph.microsoft.com/.default" }
};

Verwendung mit Erweiterungsmethoden:

var options = new MicrosoftIdentityMessageHandlerOptions
{
    Scopes = { "api://myapi/.default" }
};
options.WithAgentIdentity("agent-guid");

Konstruktoren

Name Beschreibung
MicrosoftIdentityMessageHandlerOptions()

Initialisiert eine neue Instanz der MicrosoftIdentityMessageHandlerOptions-Klasse.
MicrosoftIdentityMessageHandlerOptions(MicrosoftIdentityMessageHandlerOptions)

Initialisiert eine neue Instanz der MicrosoftIdentityMessageHandlerOptions Klasse, indem Werte aus einer vorhandenen Instanz kopiert werden.

Eigenschaften

Name Beschreibung
AcquireTokenOptions

Optionen im Zusammenhang mit der Tokenakquise.

(Geerbt von AuthorizationHeaderProviderOptions)
BaseUrl

Basis-URL für die aufgerufene downstream-Web-API. Beispiel "https://graph.microsoft.com/beta/": .

(Geerbt von AuthorizationHeaderProviderOptions)
CustomizeHttpRequestMessage

Bietet eine Möglichkeit für die Aufrufer-App, die HttpRequestMessage anzupassen. Um beispielsweise die Kopfzeilen anzupassen. Dies wird aufgerufen, nachdem die Nachricht gebildet wurde, einschließlich des Autorisierungsheaders und unmittelbar vor dem Senden der Nachricht.

(Geerbt von AuthorizationHeaderProviderOptions)
HttpMethod

HTTP-Methode zum Aufrufen dieser nachgeschalteten Web-API (standardmäßig Get).

(Geerbt von AuthorizationHeaderProviderOptions)
OnAfterAuthHeaderCreation

Bietet eine Möglichkeit für die Anrufer-App, den HttpRequestMessageNach dem Festlegen des Autorisierungsheaders (einschließlich des Authorization Headers) anzupassen, und unmittelbar vor dem Senden der Nachricht – der Punkt, an dem die endgültige Anforderung gelesen oder angepasst werden kann. Vorgesehen für die Benennungssymmetrie mit OnBeforeAuthHeaderCreation; sie teilt diese Anzeigedauer mit dem bereits vorhandenen CustomizeHttpRequestMessage, die weiterhin aus Gründen der Abwärtskompatibilität aufgerufen wird. Wenn beide an demselben Punkt ausgeführt werden, sollten Anrufer daher nicht von ihrer relativen Reihenfolge abhängen. Ändern Sie hier kein Material, das an ein Anforderungsbindungsprotokoll (SHRq//hb) gebunden ist, da es nach dem Signieren ausgeführt wird; verwenden Sie OnBeforeAuthHeaderCreation dafür.

(Geerbt von AuthorizationHeaderProviderOptions)
OnBeforeAuthHeaderCreation

Bietet eine Möglichkeit für die Aufrufer-App, den HttpRequestMessage Autorisierungsheader anzupassen, bevor der Autorisierungsheader erstellt wird. An diesem Punkt ist die Authorization Kopfzeile noch nicht vorhanden. Verwenden Sie diese Methode, um die Anforderung zu gestalten, die ein Anforderungsbindungsprotokoll signiert , z. B. eine SignedHttpRequest (SHR), die die Abfrage, Kopfzeilen oder den Text (die q//hb Ansprüche) an das Token bindet, sodass die Signatur die endgültige Anforderung abdeckt. Um die Anforderung nach der Erstellung des Headers zu beobachten oder anzupassen, verwenden OnAfterAuthHeaderCreation Sie (oder CustomizeHttpRequestMessage).

(Geerbt von AuthorizationHeaderProviderOptions)
ProtocolScheme

Name des Protokollschemas, das zum Erstellen des Autorisierungsheaders verwendet wird. Standardmäßig: "Bearer".

(Geerbt von AuthorizationHeaderProviderOptions)
RelativePath

Pfad relativ zum BaseUrl (z. B. "ich").

(Geerbt von AuthorizationHeaderProviderOptions)
RequestAppToken

Beschreibt, ob die downstream-API im Auftrag des aufrufenden Diensts selbst (App-Token) oder im Auftrag eines Benutzers aufgerufen wird, der vom Dienst verarbeitet wird (Benutzertoken). Wenn truedas Token im Auftrag der App angefordert wird. Andernfalls wird sie im Auftrag des Benutzers ausgeführt.

(Geerbt von AuthorizationHeaderProviderOptions)
Scopes

Ruft die Bereiche ab, die für das Token angefordert werden sollen, oder legt diese fest.

Methoden

Name Beschreibung
Clone()

Klonen Sie die Optionen (um sie außer Kraft zu setzen).

(Geerbt von AuthorizationHeaderProviderOptions)
CloneInternal()

Klonen Sie die Optionen (um sie außer Kraft zu setzen).

(Geerbt von AuthorizationHeaderProviderOptions)
GetApiUrl()

Gibt die nachgeschaltete Web-API-URL zurück.

(Geerbt von AuthorizationHeaderProviderOptions)

Gilt für:

Siehe auch