Google API Gateway API IAM

This page shows how to write Terraform for API Gateway API IAM and write them securely.

google_api_gateway_api_iam (Terraform)

The API IAM in API Gateway can be configured in Terraform with the resource name google_api_gateway_api_iam. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

The following arguments are supported:

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

  • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:[emailid]: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:[emailid]: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:[emailid]: An email address that represents a Google group. For example, admins@example.com.
    • domain:[domain]: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
  • role - (Required) The role that should be applied. Only one google_api_gateway_api_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/[parent-name]/roles/[role-name].

  • policy_data - (Required only by google_api_gateway_api_iam_policy) The policy data generated by a google_iam_policy data source.

In addition to the arguments listed above, the following computed attributes are exported:

  • etag - (Computed) The etag of the IAM policy.

Explanation in Terraform Registry

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

  • google_api_gateway_api_iam_policy: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
  • google_api_gateway_api_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the api are preserved.
  • google_api_gateway_api_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.

    Note: google_api_gateway_api_iam_policy cannot be used in conjunction with google_api_gateway_api_iam_binding and google_api_gateway_api_iam_member or they will fight over what your policy should be.

    Note: google_api_gateway_api_iam_binding resources can be used in conjunction with google_api_gateway_api_iam_member resources only if they do not grant privilege to the same role.

    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.

Frequently asked questions

What is Google API Gateway API IAM?

Google API Gateway API IAM is a resource for API Gateway of Google Cloud Platform. Settings can be wrote in Terraform.

security-icon

Scan your IaC problem in 3 minutes for free

You can keep your IaC security for free. No credit card required.