TokenClaimMappingsProfile Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:

Az.RedHatOpenShiftHcp.private.dll

External Auth claim mappings profile. At a minimum username or groups must be defined.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.TokenClaimMappingsProfileTypeConverter))]
public class TokenClaimMappingsProfile : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ITokenClaimMappingsProfile

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

Public Class TokenClaimMappingsProfile
Implements ITokenClaimMappingsProfile

Inheritance

Object

TokenClaimMappingsProfile

Attributes

TypeConverterAttribute

Implements

ITokenClaimMappingsProfile IJsonSerializable

Constructors

Name	Description
TokenClaimMappingsProfile()	Creates an new TokenClaimMappingsProfile instance.

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
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of TokenClaimMappingsProfile.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of TokenClaimMappingsProfile.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ITokenClaimMappingsProfile.
FromJsonString(String)	Creates a new instance of TokenClaimMappingsProfile, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of TokenClaimMappingsProfile into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()