History

Ludovico Magnocavallo 1ac3fe4460 New tfdoc version (#396 ) * update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos		2021-12-21 08:51:51 +01:00
..
README.md	New tfdoc version (#396 )	2021-12-21 08:51:51 +01:00
main.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
outputs.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
variables.tf	Add more validations to linter	2021-10-08 18:26:04 +02:00
versions.tf	Use the same versions file everywhere, pin to tf 1.0+ provider 4.0+ (#355 )	2021-11-03 15:05:43 +01:00

README.md

Cloud Identity Group Module

This module allows creating a Cloud Identity group and assigning members.

Usage

To use this module you must either run terraform as a user that has the Groups Admin role in Cloud Identity or enable domain-wide delegation to the service account used by terraform. If you use a service account, you must also grant that service account the Groups Admin role in Cloud Identity.

Please note that the underlying terraform resources only allow the creation of groups with members that are part of the organization. If you want to create memberships for identities outside your own organization, you have to manually allow members outside your organization in the Cloud Identity admin console.

As of version 3.50 of the GCP Terraform provider two operations are not working:

removing a group that has at least one OWNER managed by terraform (bug)
removing a role from an existing membership (bug)

Until those two bugs are fixed, this module will only support the creation of MEMBER memberships.

Examples

Simple Group

module "group" {
  source       = "./modules/cloud-identity-group"
  customer_id  = "customers/C01234567"
  name         = "mygroup@example.com"
  display_name = "My group name"
  description  = "My group Description"
  members = [
    "user1@example.com",
    "user2@example.com",
    "service-account@my-gcp-project.iam.gserviceaccount.com"
  ]
}
# tftest:modules=1:resources=4

Variables

name	description	type	required	default
customer_id	Directory customer ID in the form customers/C0xxxxxxx.	`string`	✓
display_name	Group display name.	`string`	✓
name	Group ID (usually an email).	`string`	✓
description	Group description	`string`		`null`
members	List of group members.	`list(string)`		`[]`

Outputs

name	description	sensitive
id	Group ID.
name	Group name.