IAM policy for organizations
Four different resources help you manage your IAM policy for a organization. Each of these resources serves a different use case:
googleOrganizationIamPolicy
: Authoritative. Sets the IAM policy for the organization and replaces any existing policy already attached.googleOrganizationIamBinding
: 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 organization are preserved.googleOrganizationIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the organization are preserved.googleOrganizationIamAuditConfig
: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service.
\~> Note: googleOrganizationIamPolicy
cannot be used in conjunction with googleOrganizationIamBinding
, googleOrganizationIamMember
, or googleOrganizationIamAuditConfig
or they will fight over what your policy should be.
\~> Note: googleOrganizationIamBinding
resources can be used in conjunction with googleOrganizationIamMember
resources only if they do not grant privilege to the same role.
googleOrganizationIamPolicy
!> Warning: New organizations have several default policies which will, without extreme caution, be overwritten by use of this resource. The safest alternative is to use multiple googleOrganizationIamBinding
resources. This resource makes it easy to remove your own access to an organization, which will require a call to Google Support to have fixed, and can take multiple days to resolve.
In general, this resource should only be used with organizations fully managed by Terraform.If you do use this resource, the best way to be sure that you are not making dangerous changes is to start by importing your existing policy, and examining the diff very closely.
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
binding: [
{
members: ["user:jane@example.com"],
role: "roles/editor",
},
],
});
new google.organizationIamPolicy.OrganizationIamPolicy(this, "organization", {
org_id: "your-organization-id",
policy_data: dataGoogleIamPolicyAdmin.policyData,
});
With IAM Conditions:
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
binding: [
{
condition: [
{
description: "Expiring at midnight of 2019-12-31",
expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
title: "expires_after_2019_12_31",
},
],
members: ["user:jane@example.com"],
role: "roles/editor",
},
],
});
new google.organizationIamPolicy.OrganizationIamPolicy(this, "organization", {
org_id: "your-organization-id",
policy_data: dataGoogleIamPolicyAdmin.policyData,
});
googleOrganizationIamBinding
\~> Note: If role
is set to roles/owner
and you don't specify a user or service account you have access to in members
, you can lock yourself out of your organization.
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.organizationIamBinding.OrganizationIamBinding(this, "organization", {
members: ["user:jane@example.com"],
org_id: "your-organization-id",
role: "roles/editor",
});
With IAM Conditions:
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.organizationIamBinding.OrganizationIamBinding(this, "organization", {
condition: [
{
description: "Expiring at midnight of 2019-12-31",
expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
title: "expires_after_2019_12_31",
},
],
members: ["user:jane@example.com"],
org_id: "your-organization-id",
role: "roles/editor",
});
googleOrganizationIamMember
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.organizationIamMember.OrganizationIamMember(this, "organization", {
member: "user:jane@example.com",
org_id: "your-organization-id",
role: "roles/editor",
});
With IAM Conditions:
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.organizationIamMember.OrganizationIamMember(this, "organization", {
condition: [
{
description: "Expiring at midnight of 2019-12-31",
expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
title: "expires_after_2019_12_31",
},
],
member: "user:jane@example.com",
org_id: "your-organization-id",
role: "roles/editor",
});
googleOrganizationIamAuditConfig
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.organizationIamAuditConfig.OrganizationIamAuditConfig(
this,
"organization",
{
audit_log_config: [
{
log_type: "ADMIN_READ",
},
{
exempted_members: ["user:joebloggs@hashicorp.com"],
log_type: "DATA_READ",
},
],
org_id: "your-organization-id",
service: "allServices",
}
);
Argument Reference
The following arguments are supported:
-
member/members
- (Required except for google_organization_iam_audit_config) 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, 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_organization_iam_audit_config) The role that should be applied. Only onegoogleOrganizationIamBinding
can be used per role. Note that custom roles must be of the formatorganizations/{{orgId}}/roles/{{roleId}}
. -
policyData
- (Required only bygoogleOrganizationIamPolicy
) ThegoogleIamPolicy
data source that represents the IAM policy that will be applied to the organization. The policy will be merged with any existing policy applied to the organization.Changing this updates the policy.
Deleting this removes all policies from the organization, locking out users without organization-level access.
-
orgId
- (Optional) The organization ID. If not specified forgoogleOrganizationIamBinding
,googleOrganizationIamMember
, orgoogleOrganizationIamAuditConfig
, uses the ID of the organization configured with the provider. Required forgoogleOrganizationIamPolicy
- you must explicitly set the organization, and it will not be inferred from the provider. -
service
- (Required only by google_organization_iam_audit_config) Service which will be enabled for audit logging. The special valueallServices
covers all services. Note that if there are google_organization_iam_audit_config resources covering bothallServices
and a specific service then the union of the two AuditConfigs is used for that service: thelogTypes
specified in eachauditLogConfig
are enabled, and theexemptedMembers
in eachauditLogConfig
are exempted. -
auditLogConfig
- (Required only by google_organization_iam_audit_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. -
condition
- (Optional) An IAM Condition for a given binding. Structure is documented below.
The auditLogConfig
block supports:
-
logType
- (Required) Permission type for which logging is to be configured. Must be one ofdataRead
,dataWrite
, oradminRead
. -
exemptedMembers
- (Optional) Identities that do not cause logging for this type of permission. The format is the same as that formembers
.
-
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 organization's IAM policy.
Import
IAM member imports use space-delimited identifiers; the resource in question, the role, and the account. This member resource can be imported using the orgId
, role, and member e.g.
$ terraform import google_organization_iam_member.my_organization "your-orgid roles/viewer user:foo@example.com"
IAM binding imports use space-delimited identifiers; the resource in question and the role. This binding resource can be imported using the orgId
and role, e.g.
IAM policy imports use the identifier of the resource in question. This policy resource can be imported using the orgId
.
IAM audit config imports use the identifier of the resource in question and the service, e.g.
terraform import google_organization_iam_audit_config.my_organization "your-organization-id foo.googleapis.com"
-> 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. organizations/{{orgId}}/roles/{{roleId}}
.
-> Conditional IAM Bindings: If you're importing a IAM binding with a condition block, make sure to include the title of condition, e.g. terraformImportGoogleOrganizationIamBindingMyOrganization "yourOrgIdRoles/{{roleId}}ConditionTitle"