Skip to content

IAM policy for Cloud Endpoints ServiceConsumers

Three different resources help you manage your IAM policy for Cloud Endpoints ServiceConsumers. Each of these resources serves a different use case:

  • googleEndpointsServiceConsumersIamPolicy: Authoritative. Sets the IAM policy for the serviceconsumers and replaces any existing policy already attached.
  • googleEndpointsServiceConsumersIamBinding: 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 serviceconsumers are preserved.
  • googleEndpointsServiceConsumersIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the serviceconsumers are preserved.

\~> Note: googleEndpointsServiceConsumersIamPolicy cannot be used in conjunction with googleEndpointsServiceConsumersIamBinding and googleEndpointsServiceConsumersIamMember or they will fight over what your policy should be.

\~> Note: googleEndpointsServiceConsumersIamBinding resources can be used in conjunction with googleEndpointsServiceConsumersIamMember resources only if they do not grant privilege to the same role.

googleEndpointsServiceConsumersIamPolicy

data "google_iam_policy" "admin" {
  binding {
    role = "roles/servicemanagement.serviceController"
    members = [
      "user:jane@example.com",
    ]
  }
}

resource "google_endpoints_service_consumers_iam_policy" "policy" {
  service_name = google_endpoints_service.endpoints_service.service_name
  consumer_project = "%{consumer_project}"
  policy_data = data.google_iam_policy.admin.policy_data
}

googleEndpointsServiceConsumersIamBinding

resource "google_endpoints_service_consumers_iam_binding" "binding" {
  service_name = google_endpoints_service.endpoints_service.service_name
  consumer_project = "%{consumer_project}"
  role = "roles/servicemanagement.serviceController"
  members = [
    "user:jane@example.com",
  ]
}

googleEndpointsServiceConsumersIamMember

resource "google_endpoints_service_consumers_iam_member" "member" {
  service_name = google_endpoints_service.endpoints_service.service_name
  consumer_project = "%{consumer_project}"
  role = "roles/servicemanagement.serviceController"
  member = "user:jane@example.com"
}

Argument Reference

The following arguments are supported:

  • 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 googleEndpointsServiceConsumersIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parentName}/roles/{roleName}.

  • policyData - (Required only by googleEndpointsServiceConsumersIamPolicy) The policy data generated by a googleIamPolicy data source.

Attributes Reference

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

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

Import

For all import syntaxes, the "resource in question" can take any of the following forms:

  • services/{{service_name}}/consumers/{{consumer_project}}
  • {{service_name}}/{{consumer_project}}
  • {{consumer_project}}

Any variables not passed in the import command will be taken from the provider configuration.

Cloud Endpoints serviceconsumers IAM resources can be imported using the resource identifiers, role, and member.

IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.

$ terraform import google_endpoints_service_consumers_iam_member.editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController user:jane@example.com"

IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

$ terraform import google_endpoints_service_consumers_iam_binding.editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController"

IAM policy imports use the identifier of the resource in question, e.g.

$ terraform import google_endpoints_service_consumers_iam_policy.editor services/{{service_name}}/consumers/{{consumer_project}}

-> Custom Roles: If you're importing a IAM resource with a custom role, make sure to use the full name of the custom role, e.g. [projects/myProject|organizations/myOrg]/roles/myCustomRole.