blob: 419315c503d740b655a710e013d51a9723a04df7 [file] [log] [blame]
---
subcategory: "Cloud Platform"
description: |-
Collection of resources to manage IAM policy for a project.
---
# IAM policy for projects
Four different resources help you manage your IAM policy for a project. Each of these resources serves a different use case:
* `google_project_iam_policy`: Authoritative. Sets the IAM policy for the project and replaces any existing policy already attached.
* `google_project_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 project are preserved.
* `google_project_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the project are preserved.
* `google_project_iam_audit_config`: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service.
~> **Note:** `google_project_iam_policy` **cannot** be used in conjunction with `google_project_iam_binding`, `google_project_iam_member`, or `google_project_iam_audit_config` or they will fight over what your policy should be.
~> **Note:** `google_project_iam_binding` resources **can be** used in conjunction with `google_project_iam_member` resources **only if** they do not grant privilege to the same role.
~> **Note:** The underlying API method `projects.setIamPolicy` has a lot of constraints which are documented [here](https://cloud.google.com/resource-manager/reference/rest/v1/projects/setIamPolicy). In addition to these constraints,
IAM Conditions cannot be used with Basic Roles such as Owner. Violating these constraints will result in the API returning 400 error code so please review these if you encounter errors with this resource.
## google\_project\_iam\_policy
!> **Be careful!** You can accidentally lock yourself out of your project
using this resource. Deleting a `google_project_iam_policy` removes access
from anyone without organization-level access to the project. Proceed with caution.
It's not recommended to use `google_project_iam_policy` with your provider project
to avoid locking yourself out, and it should generally only be used with projects
fully managed by Terraform. If you do use this resource, it is recommended to **import** the policy before
applying the change.
```hcl
resource "google_project_iam_policy" "project" {
project = "your-project-id"
policy_data = data.google_iam_policy.admin.policy_data
}
data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
}
```
With IAM Conditions:
```hcl
resource "google_project_iam_policy" "project" {
project = "your-project-id"
policy_data = "${data.google_iam_policy.admin.policy_data}"
}
data "google_iam_policy" "admin" {
binding {
role = "roles/compute.admin"
members = [
"user:jane@example.com",
]
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
}
```
## google\_project\_iam\_binding
```hcl
resource "google_project_iam_binding" "project" {
project = "your-project-id"
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
```
With IAM Conditions:
```hcl
resource "google_project_iam_binding" "project" {
project = "your-project-id"
role = "roles/container.admin"
members = [
"user:jane@example.com",
]
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
```
## google\_project\_iam\_member
```hcl
resource "google_project_iam_member" "project" {
project = "your-project-id"
role = "roles/editor"
member = "user:jane@example.com"
}
```
With IAM Conditions:
```hcl
resource "google_project_iam_member" "project" {
project = "your-project-id"
role = "roles/firebase.admin"
member = "user:jane@example.com"
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
```
## google\_project\_iam\_audit\_config
```hcl
resource "google_project_iam_audit_config" "project" {
project = "your-project-id"
service = "allServices"
audit_log_config {
log_type = "ADMIN_READ"
}
audit_log_config {
log_type = "DATA_READ"
exempted_members = [
"user:joebloggs@hashicorp.com",
]
}
}
```
## Argument Reference
The following arguments are supported:
* `member/members` - (Required except for google\_project\_iam\_audit\_config) Identities that will be granted the privilege in `role`. google\_project\_iam\_binding expects `members` field while google\_project\_iam\_member expects `member` field.
Each entry can have one of the following values:
* **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.
* `role` - (Required except for google\_project\_iam\_audit\_config) The role that should be applied. Only one
`google_project_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_project_iam_policy`) The `google_iam_policy` data source that represents
the IAM policy that will be applied to the project. The policy will be
merged with any existing policy applied to the project.
Changing this updates the policy.
Deleting this removes all policies from the project, locking out users without
organization-level access.
* `project` - (Required) The project id of the target project. This is not
inferred from the provider.
* `service` - (Required only by google\_project\_iam\_audit\_config) Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are google\_project\_iam\_audit\_config resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `log_types` specified in each `audit_log_config` are enabled, and the `exempted_members` in each `audit_log_config` are exempted.
* `audit_log_config` - (Required only by google\_project\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is [documented below](#nested_audit_log_config).
* `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding.
Structure is [documented below](#nested_condition).
---
<a name="nested_audit_log_config"></a>The `audit_log_config` block supports:
* `log_type` - (Required) Permission type for which logging is to be configured. Must be one of `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ`.
* `exempted_members` - (Optional) Identities that do not cause logging for this type of permission. The format is the same as that for `members`.
<a name="nested_condition"></a>The `condition` block supports:
* `expression` - (Required) Textual representation of an expression in Common Expression Language syntax.
* `title` - (Required) A title for the expression, i.e. a short string describing its purpose.
* `description` - (Optional) An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
~> **Warning:** Terraform considers the `role` and condition contents (`title`+`description`+`expression`) as the
identifier for the binding. This means that if any part of the condition is changed out-of-band, Terraform will
consider it to be an entirely different resource and will treat it as such.
## Attributes Reference
In addition to the arguments listed above, the following computed attributes are
exported:
* `etag` - (Computed) The etag of the project's IAM policy.
## Import
-> **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/my-project|organizations/my-org]/roles/my-custom-role`.
-> **Conditional IAM Bindings**: If you're importing a IAM binding with a condition block, make sure
to include the title of condition, e.g. `terraform import google_project_iam_binding.my_project "{{your-project-id}} roles/{{role_id}} condition-title"`
### Importing IAM members
IAM member imports use space-delimited identifiers that contain the resource's `project_id`, `role`, and `member` e.g.
* `"{{project_id}} roles/viewer user:foo@example.com"`
An [`import` block](https://developer.hashicorp.com/terraform/language/import) (Terraform v1.5.0 and later) can be used to import IAM members:
```tf
import {
id = ""{{project_id}} roles/viewer user:foo@example.com"m"
to = google_project_iam_member.default
}
```
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can also be used:
```
$ terraform import google_project_iam_member.default "{{project_id}} roles/viewer user:foo@example.com"
```
### Importing IAM bindings
IAM binding imports use space-delimited identifiers that contain the `org_id` and role, e.g.
* `"{{project_id}} roles/viewer"`
An [`import` block](https://developer.hashicorp.com/terraform/language/import) (Terraform v1.5.0 and later) can be used to import IAM bindings:
```tf
import {
id = "{{project_id}} roles/viewer"
to = google_project_iam_binding.default
}
```
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can also be used:
```
terraform import google_project_iam_binding.default "{{project_id}} roles/viewer"
```
### Importing IAM policies
IAM policy imports use the identifier of the Project only. For example:
* `"{{project_id}}"`
An [`import` block](https://developer.hashicorp.com/terraform/language/import) (Terraform v1.5.0 and later) can be used to import IAM policies:
```tf
import {
id = "{{project_id}}"
to = google_project_iam_policy.default
}
```
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can also be used:
```
$ terraform import google_project_iam_policy.default {{project_id}}
```
### Importing Audit Configs
An audit config can be imported into a `google_project_iam_audit_config` resource using the resource's `project_id` and the `service`, e.g:
* `"{{project_id}} foo.googleapis.com"`
An [`import` block](https://developer.hashicorp.com/terraform/language/import) (Terraform v1.5.0 and later) can be used to import audit configs:
```tf
import {
id = "{{project_id}} foo.googleapis.com"
to = google_project_iam_audit_config.default
}
```
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can also be used:
```
terraform import google_project_iam_audit_config.default "{{project_id}} foo.googleapis.com"
```