NamespaceSystemLibrary.Common.Framework.App.Attributes SystemLibrary.Common.Framework.App.dll

Filters access based on api-token header

Optional: set a custom token header name

Input:

`null`: Allows all

`*`: Allows all

- A regex: Value must satisfy the regex pattern

- A pipe separated list: Any part is within the Value in a case insensitive check

`text`: Value must match, case sensitive

Remarks

X

Validating as a regex expression requires any of these characters: ^$*?[

Validate case insensitive with a string.Contains match requires at least one delimiter |

Falls back to normal string equals comparison, case sensitive

ApiTokenFilterAttribute

public class ApiTokenFilterAttribute : BaseApiFilterAttribute, IActionFilter, IAsyncActionFilter, IResultFilter, IAsyncResultFilter, IOrderedFilter, IFilterMetadata

Inheritance

object

Attribute

ActionFilterAttribute

BaseApiFilterAttribute

ApiTokenFilterAttribute

Implements

IActionFilter

IAsyncActionFilter

IResultFilter

IAsyncResultFilter

IOrderedFilter

IFilterMetadata

Inherited Members

BaseApiFilterAttribute.RequestHasValidHeaderValue(string, string)

BaseApiFilterAttribute.OnAccessDenied(ActionExecutingContext, string)

ActionFilterAttribute.OnActionExecuted(ActionExecutedContext)

ActionFilterAttribute.OnActionExecutionAsync(ActionExecutingContext, ActionExecutionDelegate)

ActionFilterAttribute.OnResultExecuting(ResultExecutingContext)

ActionFilterAttribute.OnResultExecuted(ResultExecutedContext)

ActionFilterAttribute.OnResultExecutionAsync(ResultExecutingContext, ResultExecutionDelegate)

ActionFilterAttribute.Order

Examples

X

[ApiTokenFilter(null)] // Allows all
[ApiTokenFilter("*")] // Allows all
[ApiTokenFilter("^[ab0-4]{4,}$")] // Passing a regex - allow any tokens containing `a, b, 0, 1, 2, 3 or 4` with a minimum length of 4
[ApiTokenFilter("SystemLibrary.com")] // Exact match of SystemLibrary.com, case sensitive
[ApiTokenFilter("test.systemlibrary.com|test2.systemlibrary.com")] // String contains delimited by | allows test.systemlibrary.com or test2.systemlibrary.com anywhere, case insensitive

Arguments

X

Constructors

match: either a regex, an exact string, or strings delimited by |

Remarks

X

Validating as a regex expression requires any of these characters: ^$*?[

Validate case insensitive with a string.Contains match requires at least one delimiter |

Falls back to normal string equals comparison, case sensitive

public ApiTokenFilterAttribute(string match, string headerName = "api-token")

X

Methods arguments

Type	Name	Description
string	match
string	headerName

Methods

Called before the action executes, after model binding is complete.

Remarks

X

Validating as a regex expression requires any of these characters: ^$*?[

Validate case insensitive with a string.Contains match requires at least one delimiter |

Falls back to normal string equals comparison, case sensitive

public override void OnActionExecuting(ActionExecutingContext context)

X

Methods arguments

Type	Name	Description
ActionExecutingContext	context	The ActionExecutingContext.

Overrides

ActionFilterAttribute.OnActionExecuting(ActionExecutingContext)

Implements

IActionFilter

IAsyncActionFilter

IResultFilter

IAsyncResultFilter

IOrderedFilter

IFilterMetadata

Extension Methods

ObjectExtensions.Json(object, bool)

ObjectExtensions.Json(object, JsonSerializerOptions, bool, params JsonConverter[])

ObjectExtensions.Json(object, params JsonConverter[])

ObjectExtensions.Xml(object)

}