Class ProtectedResourceEndpointConventionBuilderExtensions

Namespace

Keycloak.AuthServices.Authorization

Assembly

Keycloak.AuthServices.Authorization.dll

Authorization extension methods for IEndpointConventionBuilder.

public static class ProtectedResourceEndpointConventionBuilderExtensions

Inheritance

object

ProtectedResourceEndpointConventionBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

IgnoreProtectedResource<TBuilder>(TBuilder, string)

Adds IgnoreProtectedResourceAttribute to the endpoint(s).

public static TBuilder IgnoreProtectedResource<TBuilder>(this TBuilder builder, string resource) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

IgnoreProtectedResources<TBuilder>(TBuilder)

Adds IgnoreProtectedResourceAttribute to the endpoint(s).

public static TBuilder IgnoreProtectedResources<TBuilder>(this TBuilder builder) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

RequireProtectedResource<TBuilder>(TBuilder, string)

Adds ProtectedResourceAttribute to the endpoint(s).

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

RequireProtectedResource<TBuilder>(TBuilder, string, string)

Adds ProtectedResourceAttribute to the endpoint(s).

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource, string scope) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scope string

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

RequireProtectedResource<TBuilder>(TBuilder, string, string, Type)

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource, string scope, Type resolverType) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scope string

resolverType Type

The type of IParameterResolver to use.

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

RequireProtectedResource<TBuilder>(TBuilder, string, string[])

Adds ProtectedResourceAttribute to the endpoint(s).

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource, string[] scopes) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scopes string[]

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

RequireProtectedResource<TBuilder>(TBuilder, string, string[], Type)

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource, string[] scopes, Type resolverType) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scopes string[]

resolverType Type

The type of IParameterResolver to use.

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

RequireProtectedResource<TBuilder>(TBuilder, string, Type)

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder>(this TBuilder builder, string resource, Type resolverType) where TBuilder : IEndpointConventionBuilder

Parameters

builder TBuilder

The endpoint convention builder.

resource string

resolverType Type

The type of IParameterResolver to use.

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

RequireProtectedResource<TBuilder, TResolver>(TBuilder, string)

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder, TResolver>(this TBuilder builder, string resource) where TBuilder : IEndpointConventionBuilder where TResolver : IParameterResolver

Parameters

builder TBuilder

The endpoint convention builder.

resource string

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

TResolver

The type of IParameterResolver to use for resolving resource template parameters.

RequireProtectedResource<TBuilder, TResolver>(TBuilder, string, string)

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder, TResolver>(this TBuilder builder, string resource, string scope) where TBuilder : IEndpointConventionBuilder where TResolver : IParameterResolver

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scope string

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

TResolver

The type of IParameterResolver to use for resolving resource template parameters.

RequireProtectedResource<TBuilder, TResolver>(TBuilder, string, string[])

Adds ProtectedResourceAttribute to the endpoint(s) with a custom IParameterResolver.

public static TBuilder RequireProtectedResource<TBuilder, TResolver>(this TBuilder builder, string resource, string[] scopes) where TBuilder : IEndpointConventionBuilder where TResolver : IParameterResolver

Parameters

builder TBuilder

The endpoint convention builder.

resource string

scopes string[]

Returns

TBuilder

The original convention builder parameter.

Type Parameters

TBuilder

The type of endpoint convention builder.

TResolver

The type of IParameterResolver to use for resolving resource template parameters.