Add-KrJWTAudience

SYNOPSIS

Adds an audience to the JWT token builder.

SYNTAX

Add-KrJWTAudience [-Builder] <JwtTokenBuilder> [-Audience] <String> [<CommonParameters>]

DESCRIPTION

This function adds an audience to the JWT token builder, allowing for the specification of the token’s audience.

EXAMPLES

EXAMPLE 1

$builder = New-KrJWTTokenBuilder | Add-KrJWTAudience -Audience "myAudience"
This example creates a new JWT token builder and adds an audience to it.

PARAMETERS

-Builder

The JWT token builder to modify.

Type: JwtTokenBuilder
Parameter Sets: (All)
Aliases:

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

-Audience

The audience to set for the JWT token.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
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.Jwt.JwtTokenBuilder]

The modified JWT token builder.

NOTES

This function is part of the Kestrun.Jwt module and is used to build JWT tokens Maps to JwtTokenBuilder.WithAudience

RELATED LINKS