Interface IAuthorizationBuilder

Provides an interface that allows authorization to be configured

Namespace: FunctionMonkey.Abstractions.Builders
Assembly: FunctionMonkey.Abstractions.dll
Syntax
public interface IAuthorizationBuilder

Methods

| Improve this Doc View Source

AuthorizationDefault(AuthorizationTypeEnum)

Allows the default authorization mode for HTTP functions to be set. Defaults to Function Code if this method is not used.

Declaration
IAuthorizationBuilder AuthorizationDefault(AuthorizationTypeEnum authorizationDefault)
Parameters
Type Name Description
AuthorizationTypeEnum authorizationDefault
Returns
Type Description
IAuthorizationBuilder

The builder for use in a Fluent API
| Improve this Doc View Source

Claims(Action<IClaimsMappingBuilder>)

Allow claims to be mapped to command properties

Declaration
IAuthorizationBuilder Claims(Action<IClaimsMappingBuilder> claimsMappingBuilder)
Parameters
Type Name Description
Action<IClaimsMappingBuilder> claimsMappingBuilder

An action that is given a claims mapping builder
Returns
Type Description
IAuthorizationBuilder
| Improve this Doc View Source

ClaimsPrincipalAuthorizationDefault<TAuthorizationType>()

Set a default claims principal authorization type for all HTTP routes

Declaration
IAuthorizationBuilder ClaimsPrincipalAuthorizationDefault<TAuthorizationType>()
    where TAuthorizationType : IClaimsPrincipalAuthorization
Returns
Type Description
IAuthorizationBuilder
Type Parameters
Name Description
TAuthorizationType

The authorizer - must implement IClaimsPrincipalAuthorization
| Improve this Doc View Source

CustomClaimsBinder<TCustomClaimsBinder>()

Allows a custom claims binder to be registered. This can only occur globally and must take responsibility for all claims mapping.

Declaration
IAuthorizationBuilder CustomClaimsBinder<TCustomClaimsBinder>()
    where TCustomClaimsBinder : ICommandClaimsBinder
Returns
Type Description
IAuthorizationBuilder

The builder for use in a Fluent API
Type Parameters
Name Description
TCustomClaimsBinder

The type of the claims binder
| Improve this Doc View Source

TokenValidator<TTokenValidator>(String)

Allows a token validator to be configured for authorization headers to be resolved into a ClaimsPrincipal. A validator must be configured for authorization to be applied to HTTP functions

Declaration
IAuthorizationBuilder TokenValidator<TTokenValidator>(string header = null)
    where TTokenValidator : ITokenValidator
Parameters
Type Name Description
System.String header

Optional. Allows the token to be picked up from an alternate header rather than the Authorization header - useful if, for example, you need to support a legacy API Key approach
Returns
Type Description
IAuthorizationBuilder

The builder for use in a Fluent API
Type Parameters
Name Description
TTokenValidator

The token validators concrete class

Extension Methods