ControllerBase.Forbid Method
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.
| Forbid(AuthenticationProperties, String[]) |
Creates a ForbidResult (Status403Forbidden by default) with the
specified authentication schemes and |
| Forbid() |
Creates a ForbidResult (Status403Forbidden by default). |
| Forbid(AuthenticationProperties) |
Creates a ForbidResult (Status403Forbidden by default) with the
specified |
| Forbid(AuthenticationProperties) |
Creates a ForbidResult with the specified |
| Forbid(String[]) |
Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes. |
| Forbid(AuthenticationProperties, String[]) |
Creates a ForbidResult with the specified specified authentication schemes and
|
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.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);[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties, params string[] authenticationSchemes);[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid (properties As AuthenticationProperties, ParamArray authenticationSchemes As String()) As ForbidResultParameters
- properties
- AuthenticationProperties
AuthenticationProperties used to perform the authentication challenge.
- authenticationSchemes
- String[]
The authentication schemes to challenge.
Returns
The created ForbidResult for the response.
- Attributes
Remarks
Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.
Applies to
ASP.NET Core 9.0 and other versions
| Product | Versions |
|---|---|
| ASP.NET Core | 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0 |
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
Creates a ForbidResult (Status403Forbidden by default).
public:
virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid();[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid ();[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : unit -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : unit -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid () As ForbidResultReturns
The created ForbidResult for the response.
- Attributes
Remarks
Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.
Applies to
ASP.NET Core 9.0 and other versions
| Product | Versions |
|---|---|
| ASP.NET Core | 1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0 |
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
Creates a ForbidResult (Status403Forbidden by default) with the
specified properties.
public:
virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid (properties As AuthenticationProperties) As ForbidResultParameters
- properties
- AuthenticationProperties
AuthenticationProperties used to perform the authentication challenge.
Returns
The created ForbidResult for the response.
- Attributes
Remarks
Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.
Applies to
ASP.NET Core 9.0 and other versions
| Product | Versions |
|---|---|
| ASP.NET Core | 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0 |
Creates a ForbidResult with the specified properties.
public:
virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^ properties);[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties properties);[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid (properties As AuthenticationProperties) As ForbidResultParameters
- properties
- AuthenticationProperties
AuthenticationProperties used to perform the authentication challenge.
Returns
The created ForbidResult for the response.
- Attributes
Applies to
ASP.NET Core 1.1 and ASP.NET Core 1.0
| Product | Versions |
|---|---|
| ASP.NET Core | 1.0, 1.1 |
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes.
public:
virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(... cli::array <System::String ^> ^ authenticationSchemes);[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (params string[] authenticationSchemes);[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : string[] -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : string[] -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid (ParamArray authenticationSchemes As String()) As ForbidResultParameters
- authenticationSchemes
- String[]
The authentication schemes to challenge.
Returns
The created ForbidResult for the response.
- Attributes
Remarks
Some authentication schemes, such as cookies, will convert Status403Forbidden to a redirect to show a login page.
Applies to
ASP.NET Core 9.0 and other versions
| Product | Versions |
|---|---|
| ASP.NET Core | 1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0 |
Creates a ForbidResult with the specified specified authentication schemes and
properties.
public:
virtual Microsoft::AspNetCore::Mvc::ForbidResult ^ Forbid(Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^ properties, ... cli::array <System::String ^> ^ authenticationSchemes);[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.ForbidResult Forbid (Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties properties, params string[] authenticationSchemes);[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member Forbid : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResult
override this.Forbid : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.ForbidResultPublic Overridable Function Forbid (properties As AuthenticationProperties, ParamArray authenticationSchemes As String()) As ForbidResultParameters
- properties
- AuthenticationProperties
AuthenticationProperties used to perform the authentication challenge.
- authenticationSchemes
- String[]
The authentication schemes to challenge.
Returns
The created ForbidResult for the response.
- Attributes
Applies to
ASP.NET Core 1.1 and ASP.NET Core 1.0
| Product | Versions |
|---|---|
| ASP.NET Core | 1.0, 1.1 |