ExternalAuthClientProfile Class
Definition
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.
External Auth client profile This configures how on-cluster, platform clients should request tokens from the identity provider.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ExternalAuthClientProfileTypeConverter))]
public class ExternalAuthClientProfile : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IExternalAuthClientProfile
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ExternalAuthClientProfileTypeConverter))>]
type ExternalAuthClientProfile = class
interface IExternalAuthClientProfile
interface IJsonSerializable
Public Class ExternalAuthClientProfile
Implements IExternalAuthClientProfile
- Inheritance
-
ExternalAuthClientProfile
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| ExternalAuthClientProfile() |
Creates an new ExternalAuthClientProfile instance. |
Properties
| Name | Description |
|---|---|
| ClientId |
External Auth client id The clientId must appear in the audience field of the TokenIssuerProfile. |
| ComponentAuthClientNamespace |
The namespace of the external Auth client This specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with name as a unique identifier. |
| ComponentName |
The name of the external auth client This specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with namespace as a unique identifier. |
| ExtraScope |
external auth client scopes This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes. When omitted, no additional scopes are requested. |
| Type |
Determines the OIDC provider client type. |
Methods
| Name | Description |
|---|---|
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ExternalAuthClientProfile. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ExternalAuthClientProfile. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IExternalAuthClientProfile. |
| FromJsonString(String) |
Creates a new instance of ExternalAuthClientProfile, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of ExternalAuthClientProfile into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |