Class ProtectedResourceAttribute

Namespace

Keycloak.AuthServices.Authorization

Assembly

Keycloak.AuthServices.Authorization.dll

Specifies that the class or method that this attribute is applied to requires the specified authorization.

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public sealed class ProtectedResourceAttribute : Attribute, IProtectedResourceData

Inheritance

object

Attribute

ProtectedResourceAttribute

Implements

IProtectedResourceData

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Initializes a new instance of the ProtectedResourceAttribute class with the specified policy.

Constructors

ProtectedResourceAttribute(string, string?)

Initializes a new instance of the ProtectedResourceAttribute class with the specified policy.

public ProtectedResourceAttribute(string resource, string? scope = null)

Parameters

resource string

scope string

ProtectedResourceAttribute(string, string[])

Specifies that the class or method that this attribute is applied to requires the specified authorization.

public ProtectedResourceAttribute(string resource, string[] scopes)

Parameters

resource string

scopes string[]

Remarks

Initializes a new instance of the ProtectedResourceAttribute class with the specified policy.

Properties

Audience

Gets the Keycloak client ID of the resource server to use as the UMA audience parameter. When null, the global KeycloakAuthorizationServerOptions.Resource value is used.

public string? Audience { get; set; }

Property Value

string

ResolverType

Gets or sets the type of IParameterResolver used to resolve resource template parameters. When null, the default RouteParameterResolver is used.

public Type? ResolverType { get; set; }

Property Value

Type

Resource

Gets or sets resource name

public string Resource { get; }

Property Value

string

Scopes

Get or sets scopes

public string[]? Scopes { get; }

Property Value

string[]