通过

HttpRequestMessageAuthenticationExtensions.GetAuthenticationOptions Method

Definition

Namespace:
Microsoft.Identity.Web
Assembly:
Microsoft.Identity.Web.TokenAcquisition.dll
Package:
Microsoft.Identity.Web.TokenAcquisition v4.0.1

Gets the authentication options that have been set for the HTTP request.

public static Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions? GetAuthenticationOptions(this System.Net.Http.HttpRequestMessage request);
static member GetAuthenticationOptions : System.Net.Http.HttpRequestMessage -> Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions
<Extension()>
Public Function GetAuthenticationOptions (request As HttpRequestMessage) As MicrosoftIdentityMessageHandlerOptions

Parameters

request
HttpRequestMessage

The HTTP request message to examine.

Returns

MicrosoftIdentityMessageHandlerOptions

The MicrosoftIdentityMessageHandlerOptions if previously set using WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions) or WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>), otherwise null.

Exceptions

ArgumentNullException

Thrown when request is null.

Examples

var request = new HttpRequestMessage(HttpMethod.Get, "/api/data")
    .WithAuthenticationOptions(options => options.Scopes.Add("custom.scope"));

var options = request.GetAuthenticationOptions();
if (options != null)
{
    Console.WriteLine($"Request has {options.Scopes.Count} scopes configured.");
}

Remarks

This method is primarily used internally by MicrosoftIdentityMessageHandler but can also be useful for debugging or conditional logic based on authentication configuration.

Applies to