Share via


AuthorizeAttribute Class

Specifies the authorization filter that verifies the request's IPrincipal.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Web.Http.Filters.FilterAttribute
      System.Web.Http.Filters.AuthorizationFilterAttribute
        System.Web.Http.AuthorizeAttribute

Namespace:  System.Web.Http
Assembly:  System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := True,  _
    AllowMultiple := True)> _
Public Class AuthorizeAttribute _
    Inherits AuthorizationFilterAttribute
'Usage
Dim instance As AuthorizeAttribute
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
    AllowMultiple = true)]
public class AuthorizeAttribute : AuthorizationFilterAttribute
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = true, 
    AllowMultiple = true)]
public ref class AuthorizeAttribute : public AuthorizationFilterAttribute
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
    AllowMultiple = true)>]
type AuthorizeAttribute =  
    class
        inherit AuthorizationFilterAttribute
    end
public class AuthorizeAttribute extends AuthorizationFilterAttribute

The AuthorizeAttribute type exposes the following members.

Constructors

  Name Description
Public method AuthorizeAttribute Initializes a new instance of the AuthorizeAttribute class.

Top

Properties

  Name Description
Public property AllowMultiple Gets a value that indicates whether multiple filters are allowed. (Inherited from FilterAttribute.)
Public property Roles Gets or sets the authorized roles.
Public property TypeId Gets a unique identifier for this attribute. (Overrides Attribute.TypeId.)
Public property Users Gets or sets the authorized users.

Top

Methods

  Name Description
Public method Equals (Inherited from Attribute.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Protected method HandleUnauthorizedRequest Processes requests that fail authorization.
Protected method IsAuthorized Indicates whether the specified control is authorized.
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAuthorization Calls when an action is being authorized. (Overrides AuthorizationFilterAttribute.OnAuthorization(HttpActionContext).)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate method IAuthorizationFilter.ExecuteAuthorizationFilterAsync Executes the authorization filter during synchronization. (Inherited from AuthorizationFilterAttribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke (Inherited from Attribute.)

Top

Remarks

You can declare multiple AuthorizeAttribute per action. You can also use AllowAnonymousAttribute to disable authorization for a specific action.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Http Namespace