Package com.hashicorp.cdktf.providers.google.iam_workforce_pool_provider

Interface IamWorkforcePoolProviderExtraAttributesOauth2Client

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IamWorkforcePoolProviderExtraAttributesOauth2Client.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.565Z")
@Stability(Stable)
public interface IamWorkforcePoolProviderExtraAttributesOauth2Client
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IamWorkforcePoolProviderExtraAttributesOauth2Client.Builder	A builder for IamWorkforcePoolProviderExtraAttributesOauth2Client
static class	IamWorkforcePoolProviderExtraAttributesOauth2Client.Jsii$Proxy	An implementation for IamWorkforcePoolProviderExtraAttributesOauth2Client

Method Summary

Modifier and Type	Method	Description
static IamWorkforcePoolProviderExtraAttributesOauth2Client.Builder	builder()
String	getAttributesType()	Represents the IdP and type of claims that should be fetched.
String	getClientId()	The OAuth 2.0 client ID for retrieving extra attributes from the identity provider.
IamWorkforcePoolProviderExtraAttributesOauth2ClientClientSecret	getClientSecret()	client_secret block.
String	getIssuerUri()	The OIDC identity provider's issuer URI.
default IamWorkforcePoolProviderExtraAttributesOauth2ClientQueryParameters	getQueryParameters()	query_parameters block.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttributesType

@Stability(Stable)
@NotNull
String getAttributesType()

Represents the IdP and type of claims that should be fetched.

* AZURE_AD_GROUPS_MAIL: Used to get the user's group claims from the Azure AD identity provider using configuration provided in ExtraAttributesOAuth2Client and 'mail' property of the 'microsoft.graph.group' object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on 'microsoft.graph.group' properties. The attributes obtained from idntity provider are mapped to 'assertion.groups'. Possible values: ["AZURE_AD_GROUPS_MAIL"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#attributes_type IamWorkforcePoolProvider#attributes_type}

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#client_id IamWorkforcePoolProvider#client_id}

getClientSecret

@Stability(Stable)
@NotNull
IamWorkforcePoolProviderExtraAttributesOauth2ClientClientSecret getClientSecret()

client_secret block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#client_secret IamWorkforcePoolProvider#client_secret}

getIssuerUri

@Stability(Stable)
@NotNull
String getIssuerUri()

The OIDC identity provider's issuer URI.

Must be a valid URI using the 'https' scheme. Required to get the OIDC discovery document. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#issuer_uri IamWorkforcePoolProvider#issuer_uri}

getQueryParameters

@Stability(Stable)
@Nullable
default IamWorkforcePoolProviderExtraAttributesOauth2ClientQueryParameters getQueryParameters()

query_parameters block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#query_parameters IamWorkforcePoolProvider#query_parameters}

builder

@Stability(Stable)
static IamWorkforcePoolProviderExtraAttributesOauth2Client.Builder builder()

Returns:

a IamWorkforcePoolProviderExtraAttributesOauth2Client.Builder of IamWorkforcePoolProviderExtraAttributesOauth2Client