ITokenClaimMappingsProfile Interface

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.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.TokenClaimMappingsProfileTypeConverter))]
public interface ITokenClaimMappingsProfile : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Runtime.IJsonSerializable

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.TokenClaimMappingsProfileTypeConverter))>]
type ITokenClaimMappingsProfile = interface
    interface IJsonSerializable

Public Interface ITokenClaimMappingsProfile
Implements IJsonSerializable

Derived: Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.TokenClaimMappingsProfile

Attributes: TypeConverterAttribute

Implements: IJsonSerializable

Properties

Name	Description
GroupClaim	Claim name of the external profile
GroupPrefix	Prefix for the claim external profile. If this is specified, prefixPolicy will be set to "Prefix" by default.
UsernameClaim	Claim name of the external profile
UsernamePrefix	Prefix for the claim external profile. Must be set when the prefixPolicy field is set to 'Prefix' and must be unset otherwise.
UsernamePrefixPolicy	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

Methods

Name	Description
ToJson(JsonObject, SerializationMode)	(Inherited from IJsonSerializable)

Applies to