ITokenClaimMappingsProfile.UsernamePrefixPolicy Property

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:: Az.RedHatOpenShiftHcp.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prefix policy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field. Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the default policy is 'None'. When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'. When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim. When set to 'None', this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends {issuerURL}# to the value of the JWT claim when the claim is not 'email'. As an example, consider the following scenario: prefix is unset, issuerURL is set to https://myoidc.tld, the JWT claims include "username":"userA" and "email":"userA

[Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.PSArgumentCompleter(new System.String[] { "None", "Prefix", "NoPrefix" })]
[Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Runtime.Info(Create=true, Description="Prefix policy is an optional field that configures how a prefix should be\r\n        applied to the value of the JWT claim specified in the 'claim' field.\r\n\r\n        Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the\r\n        default policy is 'None'.\r\n\r\n        When set to 'Prefix', the value specified in the prefix field will be\r\n        prepended to the value of the JWT claim.\r\n        The prefix field must be set when prefixPolicy is 'Prefix'.\r\n\r\n        When set to 'NoPrefix', no prefix will be prepended to the value\r\n        of the JWT claim.\r\n\r\n        When set to 'None', this means no opinion and the platform is left to choose\r\n        any prefixes that are applied which is subject to change over time.\r\n        Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim\r\n        when the claim is not 'email'.\r\n        As an example, consider the following scenario:\r\n        `prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,\r\n        the JWT claims include "username":"userA" and "email":"userA", PossibleTypes=new System.Type[] { typeof(System.String) }, Read=true, ReadOnly=false, Required=false, SerializedName="prefixPolicy", Update=true)]
public string UsernamePrefixPolicy { get; set; }

[<Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.PSArgumentCompleter(new System.String[] { "None", "Prefix", "NoPrefix" })>]
[<Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Runtime.Info(Create=true, Description="Prefix policy is an optional field that configures how a prefix should be\r\n        applied to the value of the JWT claim specified in the 'claim' field.\r\n\r\n        Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the\r\n        default policy is 'None'.\r\n\r\n        When set to 'Prefix', the value specified in the prefix field will be\r\n        prepended to the value of the JWT claim.\r\n        The prefix field must be set when prefixPolicy is 'Prefix'.\r\n\r\n        When set to 'NoPrefix', no prefix will be prepended to the value\r\n        of the JWT claim.\r\n\r\n        When set to 'None', this means no opinion and the platform is left to choose\r\n        any prefixes that are applied which is subject to change over time.\r\n        Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim\r\n        when the claim is not 'email'.\r\n        As an example, consider the following scenario:\r\n        `prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,\r\n        the JWT claims include "username":"userA" and "email":"userA", PossibleTypes=new System.Type[] { typeof(System.String) }, Read=true, ReadOnly=false, Required=false, SerializedName="prefixPolicy", Update=true)>]
member this.UsernamePrefixPolicy : string with get, set

Public Property UsernamePrefixPolicy As String

Property Value

String

Attributes: PSArgumentCompleterAttribute InfoAttribute

Applies to