ExternalAuthProperties Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:

Az.RedHatOpenShiftHcp.private.dll

External Auth profile

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ExternalAuthPropertiesTypeConverter))]
public class ExternalAuthProperties : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IExternalAuthProperties

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ExternalAuthPropertiesTypeConverter))>]
type ExternalAuthProperties = class
    interface IExternalAuthProperties
    interface IJsonSerializable

Public Class ExternalAuthProperties
Implements IExternalAuthProperties

Inheritance

Object

ExternalAuthProperties

Attributes

TypeConverterAttribute

Implements

IExternalAuthProperties IJsonSerializable

Constructors

Name	Description
ExternalAuthProperties()	Creates an new ExternalAuthProperties instance.

Properties

Name	Description
ClaimValidationRule	The claim validation rules.
Client	External Auth OIDC clients There must not be more than 20 entries and entries must have unique namespace/name pairs.
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.
IssuerAudience	This configures the acceptable audiences for JWT tokens issued by the identity provider. At least one of the entries must match the 'aud' claim in the JWT token. Audiences must contain at least one entry and must not exceed ten entries.
IssuerCa	The issuer of the token. Certificate bundle to use to validate server certificates for the configured URL. It must be PEM encoded and when not specified, the system trust is used.
IssuerUrl	This configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers. issuerURL must use the 'https' scheme.
ProvisioningState	Provisioning state
StatusCondition	The conditions on the resource
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 ExternalAuthProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ExternalAuthProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IExternalAuthProperties.
FromJsonString(String)	Creates a new instance of ExternalAuthProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ExternalAuthProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()