Represents an attribute that is used to restrict access by callers to an action method.
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
'Declaration <AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := True, _ AllowMultiple := True)> _ Public Class AuthorizeAttribute _ Inherits FilterAttribute _ Implements IAuthorizationFilter 'Usage Dim instance As AuthorizeAttribute
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, AllowMultiple = true)] public class AuthorizeAttribute : FilterAttribute, IAuthorizationFilter
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = true, AllowMultiple = true)] public ref class AuthorizeAttribute : public FilterAttribute, IAuthorizationFilter
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, AllowMultiple = true)>] type AuthorizeAttribute = class inherit FilterAttribute interface IAuthorizationFilter end
public class AuthorizeAttribute extends FilterAttribute implements IAuthorizationFilter
The AuthorizeAttribute type exposes the following members.
|AuthorizeAttribute||Initializes a new instance of the AuthorizeAttribute class.|
|AllowMultiple||Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified. (Inherited from FilterAttribute.)|
|Order||Gets or sets the order in which the action filters are executed. (Inherited from FilterAttribute.)|
|Roles||Gets or sets the user roles.|
|TypeId||Gets the unique identifier for this attribute. (Overrides Attribute.TypeId.)|
|Users||Gets or sets the authorized users.|
|AuthorizeCore||When overridden, provides an entry point for custom authorization checks.|
|Equals||(Inherited from Attribute.)|
|Finalize||(Inherited from Object.)|
|GetHashCode||(Inherited from Attribute.)|
|GetType||(Inherited from Object.)|
|HandleUnauthorizedRequest||Processes HTTP requests that fail authorization.|
|IsDefaultAttribute||(Inherited from Attribute.)|
|Match||(Inherited from Attribute.)|
|MemberwiseClone||(Inherited from Object.)|
|OnAuthorization||Called when a process requests authorization.|
|OnCacheAuthorization||Called when the caching module requests authorization.|
|ToString||(Inherited from Object.)|
Explicit Interface Implementations
|_Attribute.GetIDsOfNames||(Inherited from Attribute.)|
|_Attribute.GetTypeInfo||(Inherited from Attribute.)|
|_Attribute.GetTypeInfoCount||(Inherited from Attribute.)|
|_Attribute.Invoke||(Inherited from Attribute.)|
Many Web applications require users to log in before the users are granted access to restricted content. In some applications, even users who are logged in might have restrictions on what content they can view or what fields they can edit.
To restrict access to an ASP.NET MVC view, you restrict access to the action method that renders the view. To accomplish this, the MVC framework provides the AuthorizeAttribute class.
This topic contains the following sections:
Deriving from AuthorizeAttribute
When you mark an action method with AuthorizeAttribute, access to that action method is restricted to users who are both authenticated and authorized. If you mark a controller with the attribute, all action methods in the controller are restricted.
The Authorize attribute lets you indicate that authorization is restricted to predefined roles or to individual users. This gives you a high degree of control over who is authorized to view any page on the site.
If an unauthorized user tries to access a method that is marked with the Authorize attribute, the MVC framework returns a 401 HTTP status code. If the site is configured to use ASP.NET forms authentication, the 401 status code causes the browser to redirect the user to the login page.
Deriving from AuthorizeAttribute
If you derive from the AuthorizeAttribute class, the derived type must be thread safe. Therefore, do not store state in an instance of the type itself (for example, in an instance field) unless that state is meant to apply to all requests. Instead, store state per request in the Items property, which is accessible through the context objects passed to AuthorizeAttribute.
The following example shows several ways to use AuthorizeAttribute. The HomeController class has three action methods that are marked with the Authorize attribute, and two that are not marked. On the AuthenticatedUsers method, the attribute limits access to users who are logged in. On the AdministratorsOnly method, the attribute limits access to users who have been assigned to either the Admin role or the Super User role. On the SpecificUserOnly method, the attribute limits access to the users whose names are Betty or Johnny. The Index and About methods can be accessed by anyone, even anonymous users.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.