UsernameClaimProfileUpdate Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:

Az.RedHatOpenShiftHcp.private.dll

External Auth claim profile This configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.UsernameClaimProfileUpdateTypeConverter))]
public class UsernameClaimProfileUpdate : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IUsernameClaimProfileUpdate

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.UsernameClaimProfileUpdateTypeConverter))>]
type UsernameClaimProfileUpdate = class
    interface IUsernameClaimProfileUpdate
    interface IJsonSerializable

Public Class UsernameClaimProfileUpdate
Implements IUsernameClaimProfileUpdate

Inheritance

Object

UsernameClaimProfileUpdate

Attributes

TypeConverterAttribute

Implements

IUsernameClaimProfileUpdate IJsonSerializable

Constructors

Name	Description
UsernameClaimProfileUpdate()	Creates an new UsernameClaimProfileUpdate instance.

Properties

Name	Description
Claim	Claim name of the external profile
Prefix	Prefix for the claim external profile. Must be set when the prefixPolicy field is set to 'Prefix' and must be unset otherwise.
PrefixPolicy	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 UsernameClaimProfileUpdate.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of UsernameClaimProfileUpdate.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IUsernameClaimProfileUpdate.
FromJsonString(String)	Creates a new instance of UsernameClaimProfileUpdate, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of UsernameClaimProfileUpdate into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()