Language

RequireAntiforgeryTokenAttribute Class

Definition

Namespace:
Microsoft.AspNetCore.Antiforgery
Assembly:
Microsoft.AspNetCore.Antiforgery.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-rc.2.26504.105
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
RequireAntiforgeryTokenAttribute.cs

An attribute that can be used to indicate whether the antiforgery token must be validated.

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)]
public class RequireAntiforgeryTokenAttribute : Attribute, Microsoft.AspNetCore.Antiforgery.IAntiforgeryMetadata
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)>]
type RequireAntiforgeryTokenAttribute = class
    inherit Attribute
    interface IAntiforgeryMetadata
Public Class RequireAntiforgeryTokenAttribute
Inherits Attribute
Implements IAntiforgeryMetadata
Inheritance
Attribute
RequireAntiforgeryTokenAttribute
Attributes
AttributeUsageAttribute
Implements
IAntiforgeryMetadata

Remarks

Validation performed by UseAntiforgery(IApplicationBuilder) only applies to HTTP POST, PUT, and PATCH requests. Endpoints using other HTTP methods are skipped by the middleware even when this attribute is applied.

If you need validation for other HTTP methods, resolve IAntiforgery and call ValidateRequestAsync(HttpContext) or IsRequestValidAsync(HttpContext) in your handler.

Constructors

Name Description
RequireAntiforgeryTokenAttribute(Boolean)

An attribute that can be used to indicate whether the antiforgery token must be validated.

Properties

Name Description
RequiresValidation

Gets or sets a value indicating whether the antiforgery token should be validated.

Applies to