Add-KrJWTBearerAuthentication

SYNOPSIS

Adds JWT Bearer authentication to the Kestrun server.

SYNTAX

Items (Default)

Add-KrJWTBearerAuthentication [-Server <KestrunHost>] -Name <String> [-ClaimPolicy <ClaimPolicyConfig>]
 [-ValidIssuer <String>] [-ValidIssuers <String[]>] [-ValidAudience <String>] [-ValidAudiences <String[]>]
 [-ValidAlgorithms <String[]>] [-SkipValidateIssuer] [-SkipValidateAudience] [-SkipValidateLifetime]
 [-ValidateIssuerSigningKey] [-DoesNotRequireExpirationTime] [-DoesNotRequireSignedTokens]
 [-IssuerSigningKey <SecurityKey>] [-IssuerSigningKeys <SecurityKey[]>] [-ClockSkew <TimeSpan>] [-PassThru]
 [<CommonParameters>]

ValParamOption

Add-KrJWTBearerAuthentication [-Server <KestrunHost>] -Name <String>
 -ValidationParameter <TokenValidationParameters> [-ClaimPolicy <ClaimPolicyConfig>] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Configures the Kestrun server to use JWT Bearer authentication for incoming requests.

EXAMPLES

EXAMPLE 1

Add-KrJWTBearerAuthentication -Server $server -Name "MyAuth" -ValidationParameter $validationParameter -ClaimPolicy $claimPolicy
Configure Kestrun server to use JWT Bearer authentication with the specified validation parameters and claim policy.

EXAMPLE 2

Add-KrJWTBearerAuthentication -Server $server -Name "MyAuth" -ValidIssuer "https://issuer" -ValidAudience "api" -ValidAlgorithms @("HS256") -SkipValidateIssuer -PassThru
Configure Kestrun server to use JWT Bearer authentication with the specified issuer, audience, and algorithms, skipping issuer validation, and return the server instance.

EXAMPLE 3

Add-KrJWTBearerAuthentication -Server $server -Name "MyAuth" -ValidIssuer "https://issuer" -ValidAudience "api" -ValidAlgorithms @("HS256") -SkipValidateIssuer -PassThru
Configure Kestrun server to use JWT Bearer authentication with the specified issuer, audience, and algorithms, skipping issuer validation, and return the server instance.

EXAMPLE 4

Add-KrJWTBearerAuthentication -Server $server -Name "MyAuth" -ValidIssuer "https://issuer" -ValidAudience "api" -ValidAlgorithms @("HS256") -SkipValidateIssuer -PassThru
Configure Kestrun server to use JWT Bearer authentication with the specified issuer, audience, and algorithms, skipping issuer validation, and return the server instance.

PARAMETERS

-Server

The Kestrun server instance to configure.

Type: KestrunHost
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the authentication scheme. This name is used to identify the authentication scheme in the Kestrun server configuration.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidationParameter

The token validation parameters used to validate incoming JWT tokens. This parameter is mandatory when using the ‘ValParamOption’ parameter set.

Type: TokenValidationParameters
Parameter Sets: ValParamOption
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClaimPolicy

The claim policy configuration for the authentication scheme.

Type: ClaimPolicyConfig
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidIssuer

The valid issuer for the JWT tokens. This parameter is used to validate the issuer of incoming tokens.

Type: String
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidIssuers

An array of valid issuers for the JWT tokens. This parameter is used to validate the issuer of incoming tokens.

Type: String[]
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidAudience

The valid audience for the JWT tokens. This parameter is used to validate the audience of incoming tokens.

Type: String
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidAudiences

An array of valid audiences for the JWT tokens. This parameter is used to validate the audience of incoming tokens.

Type: String[]
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidAlgorithms

An array of valid algorithms for the JWT tokens. This parameter is used to validate the algorithm of incoming tokens.

Type: String[]
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SkipValidateIssuer

A switch parameter that, when specified, skips validation of the issuer.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipValidateAudience

A switch parameter that, when specified, skips validation of the audience.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipValidateLifetime

A switch parameter that, when specified, skips validation of the token lifetime.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ValidateIssuerSigningKey

A switch parameter that, when specified, validates the issuer signing key.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DoesNotRequireExpirationTime

A switch parameter that, when specified, indicates that expiration time validation is not required.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DoesNotRequireSignedTokens

A switch parameter that, when specified, indicates that signed tokens are not required.

Type: SwitchParameter
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IssuerSigningKey

The security key used to validate the issuer signing key.

Type: SecurityKey
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IssuerSigningKeys

An array of security keys used to validate the issuer signing key.

Type: SecurityKey[]
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClockSkew

The amount of time the token validation should allow for clock skew.

Type: TimeSpan
Parameter Sets: Items
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

A switch parameter that, when specified, returns the Kestrun server instance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Kestrun.Hosting.KestrunHost

NOTES

This function is part of the Kestrun.Authentication module and is used to configure JWT Bearer authentication for Kestrun servers. Maps to Kestrun.Hosting.KestrunHostAuthExtensions.AddJwtBearerAuthentication

RELATED LINKS