A configuration for an external identity provider.
To get more information about WorkforcePoolProvider, see:
resource "google_iam_workforce_pool" "pool" {
workforce_pool_id = "example-pool"
parent = "organizations/123456789"
location = "global"
}
resource "google_iam_workforce_pool_provider" "example" {
workforce_pool_id = google_iam_workforce_pool.pool.workforce_pool_id
location = google_iam_workforce_pool.pool.location
provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.sub"
}
saml {
idp_metadata_xml = "<?xml version=\"1.0\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://test.com\"><md:IDPSSODescriptor protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"> <md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDpDCCAoygAwIBAgIGAX7/5qPhMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi00NTg0MjExHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjIwMjE2MDAxOTEyWhcNMzIwMjE2MDAyMDEyWjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtNDU4NDIxMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxrBl7GKz52cRpxF9xCsirnRuMxnhFBaUrsHqAQrLqWmdlpNYZTVg+T9iQ+aq/iE68L+BRZcZniKIvW58wqqS0ltXVvIkXuDSvnvnkkI5yMIVErR20K8jSOKQm1FmK+fgAJ4koshFiu9oLiqu0Ejc0DuL3/XRsb4RuxjktKTb1khgBBtb+7idEk0sFR0RPefAweXImJkDHDm7SxjDwGJUubbqpdTxasPr0W+AHI1VUzsUsTiHAoyb0XDkYqHfDzhj/ZdIEl4zHQ3bEZvlD984ztAnmX2SuFLLKfXeAAGHei8MMixJvwxYkkPeYZ/5h8WgBZPP4heS2CPjwYExt29L8QIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQARjJFz++a9Z5IQGFzsZMrX2EDR5ML4xxUiQkbhld1S1PljOLcYFARDmUC2YYHOueU4ee8Jid9nPGEUebV/4Jok+b+oQh+dWMgiWjSLI7h5q4OYZ3VJtdlVwgMFt2iz+/4yBKMUZ50g3Qgg36vE34us+eKitg759JgCNsibxn0qtJgSPm0sgP2L6yTaLnoEUbXBRxCwynTSkp9ZijZqEzbhN0e2dWv7Rx/nfpohpDP6vEiFImKFHpDSv3M/5de1ytQzPFrZBYt9WlzlYwE1aD9FHCxdd+rWgYMVVoRaRmndpV/Rq3QUuDuFJtaoX11bC7ExkOpg9KstZzA63i3VcfYv</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://test.com/sso\"/></md:IDPSSODescriptor></md:EntityDescriptor>"
}
}
resource "google_iam_workforce_pool" "pool" {
workforce_pool_id = "example-pool"
parent = "organizations/123456789"
location = "global"
}
resource "google_iam_workforce_pool_provider" "example" {
workforce_pool_id = google_iam_workforce_pool.pool.workforce_pool_id
location = google_iam_workforce_pool.pool.location
provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.sub"
}
saml {
idp_metadata_xml = "<?xml version=\"1.0\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://test.com\"><md:IDPSSODescriptor protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"> <md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDpDCCAoygAwIBAgIGAX7/5qPhMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi00NTg0MjExHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjIwMjE2MDAxOTEyWhcNMzIwMjE2MDAyMDEyWjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtNDU4NDIxMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxrBl7GKz52cRpxF9xCsirnRuMxnhFBaUrsHqAQrLqWmdlpNYZTVg+T9iQ+aq/iE68L+BRZcZniKIvW58wqqS0ltXVvIkXuDSvnvnkkI5yMIVErR20K8jSOKQm1FmK+fgAJ4koshFiu9oLiqu0Ejc0DuL3/XRsb4RuxjktKTb1khgBBtb+7idEk0sFR0RPefAweXImJkDHDm7SxjDwGJUubbqpdTxasPr0W+AHI1VUzsUsTiHAoyb0XDkYqHfDzhj/ZdIEl4zHQ3bEZvlD984ztAnmX2SuFLLKfXeAAGHei8MMixJvwxYkkPeYZ/5h8WgBZPP4heS2CPjwYExt29L8QIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQARjJFz++a9Z5IQGFzsZMrX2EDR5ML4xxUiQkbhld1S1PljOLcYFARDmUC2YYHOueU4ee8Jid9nPGEUebV/4Jok+b+oQh+dWMgiWjSLI7h5q4OYZ3VJtdlVwgMFt2iz+/4yBKMUZ50g3Qgg36vE34us+eKitg759JgCNsibxn0qtJgSPm0sgP2L6yTaLnoEUbXBRxCwynTSkp9ZijZqEzbhN0e2dWv7Rx/nfpohpDP6vEiFImKFHpDSv3M/5de1ytQzPFrZBYt9WlzlYwE1aD9FHCxdd+rWgYMVVoRaRmndpV/Rq3QUuDuFJtaoX11bC7ExkOpg9KstZzA63i3VcfYv</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://test.com/sso\"/></md:IDPSSODescriptor></md:EntityDescriptor>"
}
display_name = "Display name"
description = "A sample SAML workforce pool provider."
disabled = false
attribute_condition = "true"
}
resource "google_iam_workforce_pool" "pool" {
workforce_pool_id = "example-pool"
parent = "organizations/123456789"
location = "global"
}
resource "google_iam_workforce_pool_provider" "example" {
workforce_pool_id = google_iam_workforce_pool.pool.workforce_pool_id
location = google_iam_workforce_pool.pool.location
provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.sub"
}
oidc {
issuer_uri = "https://accounts.thirdparty.com"
client_id = "client-id"
client_secret {
value {
plain_text = "client-secret"
}
}
web_sso_config {
response_type = "CODE"
assertion_claims_behavior = "MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS"
}
}
}
resource "google_iam_workforce_pool" "pool" {
workforce_pool_id = "example-pool"
parent = "organizations/123456789"
location = "global"
}
resource "google_iam_workforce_pool_provider" "example" {
workforce_pool_id = google_iam_workforce_pool.pool.workforce_pool_id
location = google_iam_workforce_pool.pool.location
provider_id = "example-prvdr"
attribute_mapping = {
"google.subject" = "assertion.sub"
}
oidc {
issuer_uri = "https://accounts.thirdparty.com"
client_id = "client-id"
client_secret {
value {
plain_text = "client-secret"
}
}
web_sso_config {
response_type = "CODE"
assertion_claims_behavior = "MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS"
additional_scopes = ["groups", "roles"]
}
}
display_name = "Display name"
description = "A sample OIDC workforce pool provider."
disabled = false
attribute_condition = "true"
}
The following arguments are supported:
location
-
(Required)
The location for the resource.
workforce_pool_id
-
(Required)
The ID to use for the pool, which becomes the final component of the resource name.
The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens.
It must start with a letter, and cannot have a trailing hyphen.
The prefix gcp-
is reserved for use by Google, and may not be specified.
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 user-specified display name for the provider. Cannot exceed 32 characters.
description
-
(Optional)
A user-specified description of 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 the 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. This is a required field and
the mapped subject cannot exceed 127 bytes.google.groups
: Groups the authenticating user belongs to. You can grant groups access to
resources using an IAM principalSet
binding; access applies to all members of the group.google.display_name
: The name of the authenticated user. This is an optional field and
the mapped display name cannot exceed 100 bytes. If not set, google.subject
will be displayed instead.
This attribute cannot be referenced in IAM bindings.google.profile_photo
: The URL that specifies the authenticated user's thumbnail photo.
This is an optional field. When set, the image will be visible as the user's profile picture.
If not set, a generic user icon will be displayed instead.
This attribute cannot be referenced in IAM bindings.
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 workforce pool
to Google Cloud resources. For example:google.subject
:
principal://iam.googleapis.com/locations/{location}/workforcePools/{pool}/subject/{value}
google.groups
:
principalSet://iam.googleapis.com/locations/{location}/workforcePools/{pool}/group/{value}
attribute.{custom_attribute}
:
principalSet://iam.googleapis.com/locations/{location}/workforcePools/{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 OIDC providers, you must supply a custom mapping that includes 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"}
An object containing a list of "key": value
pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
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
.
google.profile_photo
and google.display_name
are not supported.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 credentials will be accepted.
The following example shows how to only allow credentials with a mapped google.groups
value of admins
: "'admins' in google.groups"
saml
-
(Optional)
Represents a SAML identity provider.
Structure is documented below.
oidc
-
(Optional)
Represents an OpenId Connect 1.0 identity provider.
Structure is documented below.
idp_metadata_xml
-
(Required)
SAML Identity provider configuration metadata xml doc.
The xml document should comply with SAML 2.0 specification.
The max size of the acceptable xml document will be bounded to 128k characters.
The metadata xml document should satisfy the following constraints:
1) Must contain an Identity Provider Entity ID.
2) Must contain at least one non-expired signing key certificate.
3) For each signing key:
a) Valid from should be no more than 7 days from now.
b) Valid to should be no more than 10 years in the future.
4) Up to 3 IdP signing keys are allowed in the metadata xml.
When updating the provider's metadata xml, at least one non-expired signing key
must overlap with the existing metadata. This requirement is skipped if there are
no non-expired signing keys present in the existing metadata.issuer_uri
-
(Required)
The OIDC issuer URI. Must be a valid URI using the 'https' scheme.
client_id
-
(Required)
The client ID. Must match the audience claim of the JWT issued by the identity provider.
client_secret
-
(Optional)
The optional client secret. Required to enable Authorization Code flow for web sign-in.
Structure is documented below.
web_sso_config
-
(Optional)
Configuration for web single sign-on for the OIDC provider. Here, web sign-in refers to console sign-in and gcloud sign-in through the browser.
Structure is documented below.
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": ""
}
]
}
The client_secret
block supports:
value
-
(Optional)
The value of the client secret.
Structure is documented below.plain_text
-
(Required)
The plain text of the client secret value.
Note: This property is sensitive and will not be displayed in the plan.
thumbprint
-
(Output)
A thumbprint to represent the current client secret value.
The web_sso_config
block supports:
response_type
-
(Required)
The Response Type to request for in the OIDC Authorization Request for web sign-in.
The CODE
Response Type is recommended to avoid the Implicit Flow, for security reasons.
response_type=code
selection uses the Authorization Code Flow for web sign-in. Requires a configured client secret.response_type=id_token
selection uses the Implicit Flow for web sign-in.
Possible values are: CODE
, ID_TOKEN
.assertion_claims_behavior
-
(Required)
The behavior for how OIDC Claims are included in the assertion
object used for attribute mapping and attribute condition.
MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS
, ONLY_ID_TOKEN_CLAIMS
.additional_scopes
-
(Optional)
Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the openid
, profile
and email
scopes that are supported by the identity provider are requested.
Each additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured.
In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format locations/{{location}}/workforcePools/{{workforce_pool_id}}/providers/{{provider_id}}
name
-
Output only. The resource name of the provider.
Format: locations/{location}/workforcePools/{workforcePoolId}/providers/{providerId}
state
-
The current state of the provider.
This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.WorkforcePoolProvider can be imported using any of these accepted formats:
locations/{{location}}/workforcePools/{{workforce_pool_id}}/providers/{{provider_id}}
{{location}}/{{workforce_pool_id}}/{{provider_id}}
In Terraform v1.5.0 and later, use an import
block to import WorkforcePoolProvider using one of the formats above. For example:
import {
id = "locations/{{location}}/workforcePools/{{workforce_pool_id}}/providers/{{provider_id}}"
to = google_iam_workforce_pool_provider.default
}
When using the terraform import
command, WorkforcePoolProvider can be imported using one of the formats above. For example:
$ terraform import google_iam_workforce_pool_provider.default locations/{{location}}/workforcePools/{{workforce_pool_id}}/providers/{{provider_id}}
$ terraform import google_iam_workforce_pool_provider.default {{location}}/{{workforce_pool_id}}/{{provider_id}}