| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds a header to the JWT token builder. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function adds a header to the JWT token builder, allowing for the specification of additional header fields |
| | | 6 | | .PARAMETER Builder |
| | | 7 | | The JWT token builder to modify. |
| | | 8 | | .PARAMETER Name |
| | | 9 | | The name of the header to add. |
| | | 10 | | .PARAMETER Value |
| | | 11 | | The value of the header to add. |
| | | 12 | | .OUTPUTS |
| | | 13 | | [Kestrun.Jwt.JwtTokenBuilder] |
| | | 14 | | The modified JWT token builder. |
| | | 15 | | .EXAMPLE |
| | | 16 | | $builder = New-KrJWTTokenBuilder | Add-KrJWTHeader -Name "customHeader" -Value "headerValue" |
| | | 17 | | This example creates a new JWT token builder and adds a custom header to it. |
| | | 18 | | .NOTES |
| | | 19 | | This function is part of the Kestrun.Jwt module and is used to build JWT tokens. |
| | | 20 | | Maps to JwtTokenBuilder.AddHeader |
| | | 21 | | .LINK |
| | | 22 | | https://docs.microsoft.com/en-us/dotnet/api/system.identitymodel.tokens.jwt.jwtsecuritytoken |
| | | 23 | | #> |
| | | 24 | | function Add-KrJWTHeader { |
| | | 25 | | [KestrunRuntimeApi('Everywhere')] |
| | | 26 | | [CmdletBinding()] |
| | | 27 | | [OutputType([Kestrun.Jwt.JwtTokenBuilder])] |
| | | 28 | | param( |
| | | 29 | | [Parameter(Mandatory = $true, ValueFromPipeline)] |
| | | 30 | | [Kestrun.Jwt.JwtTokenBuilder] $Builder, |
| | | 31 | | [Parameter(Mandatory)] |
| | | 32 | | [string] $Name, |
| | | 33 | | [Parameter(Mandatory)] |
| | | 34 | | [object] $Value |
| | | 35 | | ) |
| | | 36 | | process { |
| | 0 | 37 | | return $Builder.AddHeader($Name, $Value) |
| | | 38 | | } |
| | | 39 | | } |
| | | 40 | | |