Interface IClaimFilter<TUser>

Represent a fitler that can manipulate the claims.

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.dll

Syntax

public interface IClaimFilter<TUser>
    where TUser : class, IUser

Type Parameters

TUser

Properties

Order

Gets or sets the order value for determining the order of execution of filters. Filters execute in ascending numeric value of the Order property.

Declaration

int Order { get; set; }

Property Value

System.Int32

Remarks

Filters are executed in an ordering determined by an ascending sort of the Order property.

If two filters have the same numeric value of Order, then their relative execution order is in the order they are registered.

Methods

ExecuteAsync(ClaimFilterContext<TUser>, CancellationToken)

Executes the filter to allow for manipulation of the claims for the current sign-in.

Declaration

Task ExecuteAsync(ClaimFilterContext<TUser> context, CancellationToken cancellationToken = default(CancellationToken))

Parameters

ClaimFilterContext<TUser> context The ClaimFilterContext<TUser> with information about the on-going sign-in.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task The System.Threading.Tasks.Task that represents the asynchronous operation.