| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds a new claim policy to the KestrunClaims system. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function allows you to define a new claim policy by specifying the policy name, claim type, and allowed values. |
| | | 6 | | .PARAMETER Builder |
| | | 7 | | The claim policy builder instance used to create the policy. |
| | | 8 | | .PARAMETER PolicyName |
| | | 9 | | The name of the policy to be created. |
| | | 10 | | .PARAMETER ClaimType |
| | | 11 | | The type of claim being defined. |
| | | 12 | | .PARAMETER Scope |
| | | 13 | | If specified, indicates that the claim type is a scope. |
| | | 14 | | .PARAMETER Description |
| | | 15 | | The description of the claim policy. |
| | | 16 | | .PARAMETER UserClaimType |
| | | 17 | | The user identity claim type. |
| | | 18 | | .PARAMETER AllowedValues |
| | | 19 | | The values that are allowed for this claim. |
| | | 20 | | .EXAMPLE |
| | | 21 | | PS C:\> Add-KrClaimPolicy -Builder $builder -PolicyName "ExamplePolicy" -ClaimType "ExampleClaim" -AllowedValues "Va |
| | | 22 | | This is an example of how to use the Add-KrClaimPolicy function. |
| | | 23 | | It creates a claim policy named "ExamplePolicy" for the claim type "ExampleClaim" with allowed values "Value1" and " |
| | | 24 | | .EXAMPLE |
| | | 25 | | PS C:\> Add-KrClaimPolicy -Builder $builder -PolicyName "ScopePolicy" -Scope -AllowedValues "read", "write" |
| | | 26 | | This example creates a claim policy named "ScopePolicy" for the claim type "scope" with allowed values "read" and "w |
| | | 27 | | .NOTES |
| | | 28 | | This function is part of the Kestrun.Jwt module and is used to build Claims |
| | | 29 | | #> |
| | | 30 | | function Add-KrClaimPolicy { |
| | | 31 | | [KestrunRuntimeApi('Everywhere')] |
| | | 32 | | [CmdletBinding(DefaultParameterSetName = 'ClaimType')] |
| | | 33 | | [OutputType([Kestrun.Claims.ClaimPolicyBuilder])] |
| | | 34 | | param( |
| | | 35 | | [Parameter(Mandatory = $true, ValueFromPipeline)] |
| | | 36 | | [Kestrun.Claims.ClaimPolicyBuilder] $Builder, |
| | | 37 | | |
| | | 38 | | [Parameter(Mandatory = $true)] |
| | | 39 | | [string] $PolicyName, |
| | | 40 | | |
| | | 41 | | [Parameter(Mandatory = $true, ParameterSetName = 'ClaimType')] |
| | | 42 | | [string] $ClaimType, |
| | | 43 | | |
| | | 44 | | [Parameter(Mandatory = $true, ParameterSetName = 'UserClaimType')] |
| | | 45 | | [Kestrun.Claims.UserIdentityClaim] $UserClaimType, |
| | | 46 | | |
| | | 47 | | [Parameter(Mandatory = $true, ParameterSetName = 'Scope')] |
| | | 48 | | [switch]$Scope, |
| | | 49 | | |
| | | 50 | | [Parameter(Mandatory = $true, ParameterSetName = 'ClaimType')] |
| | | 51 | | [Parameter(Mandatory = $true, ParameterSetName = 'UserClaimType')] |
| | | 52 | | [string[]] $AllowedValues, |
| | | 53 | | |
| | | 54 | | [Parameter(Mandatory = $false)] |
| | | 55 | | [string]$Description |
| | | 56 | | ) |
| | | 57 | | begin { |
| | | 58 | | # Determine claim type based on parameter set |
| | 0 | 59 | | if ($Scope) { |
| | 0 | 60 | | $ClaimType = 'scope' |
| | 0 | 61 | | $AllowedValues = @($PolicyName) |
| | 0 | 62 | | } elseif ($UserClaimType) { |
| | | 63 | | # Use user identity claim type |
| | 0 | 64 | | $ClaimType = [Kestrun.Claims.KestrunClaimExtensions]::ToClaimUri($UserClaimType) |
| | | 65 | | } |
| | | 66 | | } |
| | | 67 | | process { |
| | 0 | 68 | | return $Builder.AddPolicy($PolicyName, $ClaimType, $Description, $AllowedValues) |
| | | 69 | | } |
| | | 70 | | } |
| | | 71 | | |