Interface CfnIdentityProviderConfig.IOidcIdentityProviderConfigProperty
An object representing the configuration for an OpenID Connect (OIDC) identity provider.
Namespace: Amazon.CDK.AWS.EKS.Legacy
Assembly: Amazon.CDK.AWS.EKS.Legacy.dll
Syntax (csharp)
public interface IOidcIdentityProviderConfigProperty
Syntax (vb)
Public Interface IOidcIdentityProviderConfigProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS.Legacy;
var oidcIdentityProviderConfigProperty = new OidcIdentityProviderConfigProperty {
ClientId = "clientId",
IssuerUrl = "issuerUrl",
// the properties below are optional
GroupsClaim = "groupsClaim",
GroupsPrefix = "groupsPrefix",
RequiredClaims = new [] { new RequiredClaimProperty {
Key = "key",
Value = "value"
} },
UsernameClaim = "usernameClaim",
UsernamePrefix = "usernamePrefix"
};
Synopsis
Properties
ClientId | This is also known as audience . |
GroupsClaim | The JSON web token (JWT) claim that the provider uses to return your groups. |
GroupsPrefix | The prefix that is prepended to group claims to prevent clashes with existing names (such as |
IssuerUrl | The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. |
RequiredClaims | The key-value pairs that describe required claims in the identity token. |
UsernameClaim | The JSON Web token (JWT) claim that is used as the username. |
UsernamePrefix | The prefix that is prepended to username claims to prevent clashes with existing names. |
Properties
ClientId
This is also known as audience .
string ClientId { get; }
Property Value
System.String
Remarks
The ID of the client application that makes authentication requests to the OIDC identity provider.
GroupsClaim
The JSON web token (JWT) claim that the provider uses to return your groups.
virtual string GroupsClaim { get; }
Property Value
System.String
Remarks
GroupsPrefix
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups).
virtual string GroupsPrefix { get; }
Property Value
System.String
Remarks
For example, the value oidc:
creates group names like oidc:engineering
and oidc:infra
. The prefix can't contain system:
IssuerUrl
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
string IssuerUrl { get; }
Property Value
System.String
Remarks
RequiredClaims
The key-value pairs that describe required claims in the identity token.
virtual object RequiredClaims { get; }
Property Value
System.Object
Remarks
If set, each claim is verified to be present in the token with a matching value.
UsernameClaim
The JSON Web token (JWT) claim that is used as the username.
virtual string UsernameClaim { get; }
Property Value
System.String
Remarks
UsernamePrefix
The prefix that is prepended to username claims to prevent clashes with existing names.
virtual string UsernamePrefix { get; }
Property Value
System.String