pulumi-aws-native-kotlin/com.pulumi.awsnative.eks.kotlin.outputs/IdentityProviderConfigOidcIdentityProviderConfig

IdentityProviderConfigOidcIdentityProviderConfig

data class IdentityProviderConfigOidcIdentityProviderConfig(val clientId: String, val groupsClaim: String? = null, val groupsPrefix: String? = null, val issuerUrl: String, val requiredClaims: List<IdentityProviderConfigRequiredClaim>? = null, val usernameClaim: String? = null, val usernamePrefix: String? = null)

An object representing an OpenID Connect (OIDC) configuration.

Constructors

constructor(clientId: String, groupsClaim: String? = null, groupsPrefix: String? = null, issuerUrl: String, requiredClaims: List<IdentityProviderConfigRequiredClaim>? = null, usernameClaim: String? = null, usernamePrefix: String? = null)

Types

Companion

object Companion

Properties

clientId

val clientId: String

This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

groupsClaim

val groupsClaim: String? = null

The JWT claim that the provider uses to return your groups.

groupsPrefix

val groupsPrefix: String? = null

The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).

issuerUrl

val issuerUrl: String

The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.

requiredClaims

val requiredClaims: List<IdentityProviderConfigRequiredClaim>? = null

The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.

usernameClaim

val usernameClaim: String? = null

The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

usernamePrefix

val usernamePrefix: String? = null

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.