A configuration for an external identity provider.
To get more information about WorkloadIdentityPoolProvider, see:
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
aws {
account_id = "999999999999"
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
display_name = "Name of provider"
description = "AWS identity pool provider for automated test"
disabled = true
attribute_condition = "attribute.aws_role==\"arn:aws:sts::999999999999:assumed-role/stack-eu-central-1-lambdaRole\""
attribute_mapping = {
"google.subject" = "assertion.arn"
"attribute.aws_account" = "assertion.account"
"attribute.environment" = "assertion.arn.contains(\":instance-profile/Production\") ? \"prod\" : \"test\""
}
aws {
account_id = "999999999999"
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.sub"
}
oidc {
issuer_uri = "https://sts.windows.net/azure-tenant-id"
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
display_name = "Name of provider"
description = "OIDC identity pool provider for automated test"
disabled = true
attribute_condition = "\"e968c2ef-047c-498d-8d79-16ca1b61e77e\" in assertion.groups"
attribute_mapping = {
"google.subject" = "\"azure::\" + assertion.tid + \"::\" + assertion.sub"
"attribute.tid" = "assertion.tid"
"attribute.managed_identity_name" = <<EOT
{
"8bb39bdb-1cc5-4447-b7db-a19e920eb111":"workload1",
"55d36609-9bcf-48e0-a366-a3cf19027d2a":"workload2"
}[assertion.oid]
EOT
}
oidc {
allowed_audiences = ["https://example.com/gcp-oidc-federation", "example.com/gcp-oidc-federation"]
issuer_uri = "https://sts.windows.net/azure-tenant-id"
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.arn"
"attribute.aws_account" = "assertion.account"
"attribute.environment" = "assertion.arn.contains(\":instance-profile/Production\") ? \"prod\" : \"test\""
}
saml {
idp_metadata_xml = file("test-fixtures/metadata.xml")
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
display_name = "Name of provider"
description = "SAML 2.0 identity pool provider for automated test"
disabled = true
attribute_mapping = {
"google.subject" = "assertion.arn"
"attribute.aws_account" = "assertion.account"
"attribute.environment" = "assertion.arn.contains(\":instance-profile/Production\") ? \"prod\" : \"test\""
}
saml {
idp_metadata_xml = file("test-fixtures/metadata.xml")
}
}
resource "google_iam_workload_identity_pool" "pool" {
workload_identity_pool_id = "example-pool"
}
resource "google_iam_workload_identity_pool_provider" "example" {
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id
workload_identity_pool_provider_id = "example-prvdr"
display_name = "Name of provider"
description = "OIDC identity pool provider for automated test"
disabled = true
attribute_condition = "\"e968c2ef-047c-498d-8d79-16ca1b61e77e\" in assertion.groups"
attribute_mapping = {
"google.subject" = "\"azure::\" + assertion.tid + \"::\" + assertion.sub"
"attribute.tid" = "assertion.tid"
"attribute.managed_identity_name" = <<EOT
{
"8bb39bdb-1cc5-4447-b7db-a19e920eb111":"workload1",
"55d36609-9bcf-48e0-a366-a3cf19027d2a":"workload2"
}[assertion.oid]
EOT
}
oidc {
allowed_audiences = ["https://example.com/gcp-oidc-federation", "example.com/gcp-oidc-federation"]
issuer_uri = "https://sts.windows.net/azure-tenant-id"
jwks_json = "{\"keys\":[{\"kty\":\"RSA\",\"alg\":\"RS256\",\"kid\":\"sif0AR-F6MuvksAyAOv-Pds08Bcf2eUMlxE30NofddA\",\"use\":\"sig\",\"e\":\"AQAB\",\"n\":\"ylH1Chl1tpfti3lh51E1g5dPogzXDaQseqjsefGLknaNl5W6Wd4frBhHyE2t41Q5zgz_Ll0-NvWm0FlaG6brhrN9QZu6sJP1bM8WPfJVPgXOanxi7d7TXCkeNubGeiLTf5R3UXtS9Lm_guemU7MxDjDTelxnlgGCihOVTcL526suNJUdfXtpwUsvdU6_ZnAp9IpsuYjCtwPm9hPumlcZGMbxstdh07O4y4O90cVQClJOKSGQjAUCKJWXIQ0cqffGS_HuS_725CPzQ85SzYZzaNpgfhAER7kx_9P16ARM3BJz0PI5fe2hECE61J4GYU_BY43sxDfs7HyJpEXKLU9eWw\"}]}"
}
}
The following arguments are supported:
workload_identity_pool_id
-
(Required)
The ID used for the pool, which is the final component of the pool resource name. This
value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix
gcp-
is reserved for use by Google, and may not be specified.
workload_identity_pool_provider_id
-
(Required)
The ID for the provider, which becomes the final component of the resource name. This
value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix
gcp-
is reserved for use by Google, and may not be specified.
display_name
-
(Optional)
A display name for the provider. Cannot exceed 32 characters.
description
-
(Optional)
A description for the provider. Cannot exceed 256 characters.
disabled
-
(Optional)
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens.
However, existing tokens still grant access.
attribute_mapping
-
(Optional)
Maps attributes from authentication credentials issued by an external identity provider
to Google Cloud attributes, such as subject
and segment
.
Each key must be a string specifying the Google Cloud IAM attribute to map to.
The following keys are supported:
google.subject
: The principal IAM is authenticating. You can reference this value
in IAM bindings. This is also the subject that appears in Cloud Logging logs.
Cannot exceed 127 characters.google.groups
: Groups the external identity belongs to. You can grant groups
access to resources using an IAM principalSet
binding; access applies to all
members of the group.
You can also provide custom attributes by specifying attribute.{custom_attribute}
,
where {custom_attribute}
is the name of the custom attribute to be mapped. You can
define a maximum of 50 custom attributes. The maximum length of a mapped attribute key
is 100 characters, and the key may only contain the characters [a-z0-9_].
You can reference these attributes in IAM policies to define fine-grained access for a
workload to Google Cloud resources. For example:google.subject
:
principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}
google.groups
:
principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}
attribute.{custom_attribute}
:
principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}
Each value must be a Common Expression Language
function that maps an identity provider credential to the normalized attribute specified
by the corresponding map key.
You can use the assertion
keyword in the expression to access a JSON representation of
the authentication credential issued by the provider.
The maximum length of an attribute mapping expression is 2048 characters. When evaluated,
the total size of all mapped attributes must not exceed 8KB.
For AWS providers, the following rules apply: {
"google.subject":"assertion.arn",
"attribute.aws_role":
"assertion.arn.contains('assumed-role')"
" ? assertion.arn.extract('{account_arn}assumed-role/')"
" + 'assumed-role/'"
" + assertion.arn.extract('assumed-role/{role_name}/')"
" : assertion.arn",
}
- If any custom attribute mappings are defined, they must include a mapping to the
`google.subject` attribute.
For OIDC providers, the following rules apply:
- Custom attribute mappings must be defined, and must include a mapping to the
google.subject
attribute. For example, the following maps the sub
claim of the
incoming credential to the subject
attribute on a Google token.
{"google.subject": "assertion.sub"}
attribute_condition
-
(Optional)
A Common Expression Language expression, in
plain text, to restrict what otherwise valid authentication credentials issued by the
provider should not be accepted.
The expression must output a boolean representing whether to allow the federation.
The following keywords may be referenced in the expressions:
assertion
: JSON representing the authentication credential issued by the provider.google
: The Google attributes mapped from the assertion in the attribute_mappings
.attribute
: The custom attributes mapped from the assertion in the attribute_mappings
.
The maximum length of the attribute condition expression is 4096 characters. If
unspecified, all valid authentication credential are accepted.
The following example shows how to only allow credentials with a mapped google.groups
value of admins
: "'admins' in google.groups"
aws
-
(Optional)
An Amazon Web Services identity provider. Not compatible with the property oidc or saml.
Structure is documented below.
oidc
-
(Optional)
An OpenId Connect 1.0 identity provider. Not compatible with the property aws or saml.
Structure is documented below.
saml
-
(Optional)
An SAML 2.0 identity provider. Not compatible with the property oidc or aws.
Structure is documented below.
project
- (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
account_id
-
(Required)
The AWS account ID.allowed_audiences
-
(Optional)
Acceptable values for the aud
field (audience) in the OIDC token. Token exchange
requests are rejected if the token audience does not match one of the configured
values. Each audience may be at most 256 characters. A maximum of 10 audiences may
be configured.
If this list is empty, the OIDC token audience must be equal to the full canonical
resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix.
For example: //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
issuer_uri
-
(Required)
The OIDC issuer URL.
jwks_json
-
(Optional)
OIDC JWKs in JSON String format. For details on definition of a
JWK, see https:tools.ietf.org/html/rfc7517. If not set, then we
use the jwks_uri
from the discovery document fetched from the
.well-known path for the issuer_uri
. Currently, RSA and EC asymmetric
keys are supported. The JWK must use following format and include only
the following fields:
{
"keys": [
{
"kty": "RSA/EC",
"alg": "<algorithm>",
"use": "sig",
"kid": "<key-id>",
"n": "",
"e": "",
"x": "",
"y": "",
"crv": ""
}
]
}
idp_metadata_xml
-
(Required)
SAML Identity provider configuration metadata xml doc.In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}}
state
-
The state of the provider.
name
-
The resource name of the provider as
projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}
.
This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.WorkloadIdentityPoolProvider can be imported using any of these accepted formats:
projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}}
{{project}}/{{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}}
{{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}}
In Terraform v1.5.0 and later, use an import
block to import WorkloadIdentityPoolProvider using one of the formats above. For example:
import {
id = "projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}}"
to = google_iam_workload_identity_pool_provider.default
}
When using the terraform import
command, WorkloadIdentityPoolProvider can be imported using one of the formats above. For example:
$ terraform import google_iam_workload_identity_pool_provider.default projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}}
$ terraform import google_iam_workload_identity_pool_provider.default {{project}}/{{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}}
$ terraform import google_iam_workload_identity_pool_provider.default {{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}}
This resource supports User Project Overrides.