IAM policy for projects
Three 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.
Note:
google_project_iam_policy
cannot be used in conjunction withgoogle_project_iam_binding
andgoogle_project_iam_member
or they will fight over what your policy should be.
Note:
google_project_iam_binding
resources can be used in conjunction withgoogle_project_iam_member
resources only if they do not grant privilege to the same role.
google_project_iam_policy
Be careful! You can accidentally lock yourself out of your project using this resource. Proceed with caution.
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:[email protected]", ] } }
google_project_iam_binding
resource "google_project_iam_binding" "project" { project = "your-project-id" role = "roles/editor" members = [ "user:[email protected]", ] }
google_project_iam_member
resource "google_project_iam_member" "project" { project = "your-project-id" role = "roles/editor" member = "user:[email protected]" }
Argument Reference
The following arguments are supported:
-
member/members
- (Required) Identities that will be granted the privilege inrole
. Each entry can have one of the following values:- user:{emailid}: An email address that represents a specific Google account. For example, [email protected] or [email protected].
- serviceAccount:{emailid}: An email address that represents a service account. For example, [email protected].
- group:{emailid}: An email address that represents a Google group. For example, [email protected].
- domain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.
-
role
- (Required) The role that should be applied. Only onegoogle_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 bygoogle_project_iam_policy
) Thegoogle_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 the policy, but leaves the original project policy intact. If there are overlapping
binding
entries between the original project policy and the data source policy, they will be removed. -
project
- (Optional) The project ID. If not specified, uses the ID of the project configured with the provider. -
authoritative
- (DEPRECATED) (Optional, only forgoogle_project_iam_policy
) A boolean value indicating if this policy should overwrite any existing IAM policy on the project. When set to true, any policies not in your config file will be removed. This can lock you out of your project until an Organization Administrator grants you access again, so please exercise caution. If this argument istrue
and you want to delete the resource, you must set thedisable_project
argument totrue
, acknowledging that the project will be inaccessible to anyone but the Organization Admins, as it will no longer have an IAM policy. Rather than using this, you should usegoogle_project_iam_binding
andgoogle_project_iam_member
. -
disable_project
- (DEPRECATED) (Optional, only forgoogle_project_iam_policy
) A boolean value that must be set totrue
if you want to delete agoogle_project_iam_policy
that is authoritative.
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. -
restore_policy
- (DEPRECATED) (Computed, only forgoogle_project_iam_policy
) The IAM policy that will be restored when a non-authoritative policy resource is deleted.
Import
IAM resources can be imported using the project_id
, role, and account.
$ terraform import google_project_iam_policy.my_project your-project-id $ terraform import google_project_iam_binding.my_project "your-project-id roles/viewer" $ terraform import google_project_iam_member.my_project "your-project-id roles/viewer [email protected]"
© 2018 HashiCorpLicensed under the MPL 2.0 License.
https://www.terraform.io/docs/providers/google/r/google_project_iam.html