Google Cloud IAM IAM Workload Identity Pool Provider

google_iam_workload_identity_pool_provider (Terraform)

The IAM Workload Identity Pool Provider in Cloud IAM can be configured in Terraform with the resource name google_iam_workload_identity_pool_provider. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

outofdevops/ghshr-gcp-wlif

resource "google_iam_workload_identity_pool_provider" "provider" {
  provider                           = google-beta
  project                            = var.project_id
  workload_identity_pool_id          = google_iam_workload_identity_pool.gh_pool.workload_identity_pool_id
  workload_identity_pool_provider_id = "gh-provider"
  attribute_mapping                  = {

Parameters

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:
  • If no attribute mapping is defined, the following default mapping applies:

    [
      "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. Structure is documented below.

• oidc - (Optional) An OpenId Connect 1.0 identity provider. Not compatible with the property 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.

The aws block supports:

• account_id - (Required) The AWS account ID.

The oidc block supports:

• 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.

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.

  • STATE_UNSPECIFIED: State unspecified.
  • ACTIVE: The provider is active, and may be used to validate authentication credentials.
  • DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted after approximately 30 days. You can restore a soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider until it is permanently deleted.

• name - The resource name of the provider as projects/[project_number]/locations/global/workloadIdentityPools/[workload_identity_pool_id]/providers/[workload_identity_pool_provider_id].

Explanation in Terraform Registry

A configuration for an external identity provider.

Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources. To get more information about WorkloadIdentityPoolProvider, see:

• API documentation
• How-to Guides
  • Managing workload identity providers