PageModel.Forbid Method

Definition

Namespace:

Microsoft.AspNetCore.Mvc.RazorPages

Assembly:

Microsoft.AspNetCore.Mvc.RazorPages.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

Forbid()	Creates a ForbidResult (Status403Forbidden by default).
Forbid(AuthenticationProperties)	Creates a ForbidResult (Status403Forbidden by default) with the specified properties.
Forbid(String[])	Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes.
Forbid(AuthenticationProperties, String[])	Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes and properties.

Forbid()

Source:

PageModel.cs

Creates a ForbidResult (Status403Forbidden by default).

public:
 virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid();

public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid ();

abstract member Forbid : unit -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : unit -> Microsoft.AspNetCore.Mvc.ForbidResult

Public Overridable Function Forbid () As ForbidResult

Returns

ForbidResult

The created ForbidResult for the response.

Remarks

Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.

Forbid(AuthenticationProperties)

Source:

PageModel.cs

Creates a ForbidResult (Status403Forbidden by default) with the specified properties.

public:
 virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);

public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);

abstract member Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResult

Public Overridable Function Forbid (properties As AuthenticationProperties) As ForbidResult

Parameters

properties

AuthenticationProperties

AuthenticationProperties used to perform the authentication challenge.

Returns

ForbidResult

The created ForbidResult for the response.

Remarks

Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.

Forbid(String[])

Source:

PageModel.cs

Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes.

public:
 virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(... cli::array <System::String ^> ^ authenticationSchemes);

public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (params string[] authenticationSchemes);

abstract member Forbid : string[] -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : string[] -> Microsoft.AspNetCore.Mvc.ForbidResult

Public Overridable Function Forbid (ParamArray authenticationSchemes As String()) As ForbidResult

Parameters

authenticationSchemes

String[]

The authentication schemes to challenge.

Returns

ForbidResult

The created ForbidResult for the response.

Remarks

Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.

Forbid(AuthenticationProperties, String[])

Source:

PageModel.cs

Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes and properties.

public:
 virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties, ... cli::array <System::String ^> ^ authenticationSchemes);

public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties, params string[] authenticationSchemes);

abstract member Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResult

Public Overridable Function Forbid (properties As AuthenticationProperties, ParamArray authenticationSchemes As String()) As ForbidResult

Parameters

properties

AuthenticationProperties

AuthenticationProperties used to perform the authentication challenge.

authenticationSchemes

String[]

The authentication schemes to challenge.

Returns

ForbidResult

The created ForbidResult for the response.

Remarks

Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.