AuthorizeAttribute Class

Article
12/19/2012

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
	AuthorizeAttribute	Initializes a new instance of the AuthorizeAttribute class.

Top

Properties

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

Top

Methods

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

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	(Inherited from Attribute.)
	_Attribute.GetTypeInfo	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	(Inherited from Attribute.)
	IAuthorizationFilter.ExecuteAuthorizationFilterAsync	Executes the authorization filter during synchronization. (Inherited from AuthorizationFilterAttribute.)
	_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.

Share via