TypedResults.Challenge(AuthenticationProperties, IList<String>) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Results.dll

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a ChallengeHttpResult that on execution invokes ChallengeAsync(HttpContext, String, AuthenticationProperties).

The behavior of this method depends on the IAuthenticationService in use. Status401Unauthorized and Status403Forbidden are among likely status results.

public static Microsoft.AspNetCore.Http.HttpResults.ChallengeHttpResult Challenge (Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties = default, System.Collections.Generic.IList<string>? authenticationSchemes = default);

static member Challenge : Microsoft.AspNetCore.Authentication.AuthenticationProperties * System.Collections.Generic.IList<string> -> Microsoft.AspNetCore.Http.HttpResults.ChallengeHttpResult

Public Shared Function Challenge (Optional properties As AuthenticationProperties = Nothing, Optional authenticationSchemes As IList(Of String) = Nothing) As ChallengeHttpResult

Parameters

properties: AuthenticationProperties

AuthenticationProperties used to perform the authentication challenge.

authenticationSchemes: IList<String>

The authentication schemes to challenge.

Returns

ChallengeHttpResult

The created ChallengeHttpResult for the response.

Applies to

Share via