IdentityProviderConfigOidcIdentityProviderConfigArgs

data class IdentityProviderConfigOidcIdentityProviderConfigArgs(val clientId: Output<String>, val groupsClaim: Output<String>? = null, val groupsPrefix: Output<String>? = null, val issuerUrl: Output<String>, val requiredClaims: Output<List<IdentityProviderConfigRequiredClaimArgs>>? = null, val usernameClaim: Output<String>? = null, val usernamePrefix: Output<String>? = null) : ConvertibleToJava<IdentityProviderConfigOidcIdentityProviderConfigArgs>

An object representing an OpenID Connect (OIDC) configuration.

Constructors

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

Properties

Link copied to clipboard
val clientId: Output<String>

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

Link copied to clipboard
val groupsClaim: Output<String>? = null

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

Link copied to clipboard
val groupsPrefix: Output<String>? = null

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

Link copied to clipboard
val issuerUrl: Output<String>

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

Link copied to clipboard

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.

Link copied to clipboard
val usernameClaim: Output<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.

Link copied to clipboard
val usernamePrefix: Output<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.

Functions

Link copied to clipboard
open override fun toJava(): IdentityProviderConfigOidcIdentityProviderConfigArgs