AuthorizeAttribute Class

 

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

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

Inheritance Hierarchy

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

Syntax

[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 : AuthorizationFilterAttribute
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method,
    Inherited = true, AllowMultiple = true)>]
type AuthorizeAttribute = 
    class
        inherit AuthorizationFilterAttribute
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method,
    Inherited := True, AllowMultiple := True)>
Public Class AuthorizeAttribute
    Inherits AuthorizationFilterAttribute

Constructors

Name Description
System_CAPS_pubmethod AuthorizeAttribute()

Initializes a new instance of the AuthorizeAttribute class.

Properties

Name Description
System_CAPS_pubproperty AllowMultiple

Gets a value that indicates whether multiple filters are allowed.(Inherited from FilterAttribute.)

System_CAPS_pubproperty Roles

Gets or sets the authorized roles.

System_CAPS_pubproperty TypeId

Gets a unique identifier for this attribute.(Overrides Attribute.TypeId.)

System_CAPS_pubproperty Users

Gets or sets the authorized users.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Attribute.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod HandleUnauthorizedRequest(HttpActionContext)

Processes requests that fail authorization.

System_CAPS_protmethod IsAuthorized(HttpActionContext)

Indicates whether the specified control is authorized.

System_CAPS_pubmethod IsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethod Match(Object)

(Inherited from Attribute.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod OnAuthorization(HttpActionContext)

Calls when an action is being authorized.(Overrides AuthorizationFilterAttribute.OnAuthorization(HttpActionContext).)

System_CAPS_pubmethod OnAuthorizationAsync(HttpActionContext, CancellationToken)

(Inherited from AuthorizationFilterAttribute.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetTypeInfoCount(UInt32)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAuthorizationFilter.ExecuteAuthorizationFilterAsync(HttpActionContext, CancellationToken, Func<Task<HttpResponseMessage>>)

Executes the authorization filter during synchronization.(Inherited from AuthorizationFilterAttribute.)

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

System.Web.Http Namespace

Return to top