You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 14, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,28 @@
8
8
9
9
## Purpose and Functionality
10
10
11
-
This is a [child-module](https://opentofu.org/docs/language/modules/#child-modules) for managing Google Workspace users, groups, and roles.
11
+
Use this [child module](https://opentofu.org/docs/language/modules/#child-modules) to manage Google Workspace users, groups, and roles.
12
+
13
+
If you want to use this module with an existing Google Workspace, see the [import-existing-org](examples/import-existing-org) example, which demonstrates how to import your existing Google users and groups.
12
14
13
15
## Usage
14
16
15
17
### Step-by-Step Instructions
16
18
17
-
There are 2 provider authentication routes available,
18
-
1 - authenticate a service account via API keys
19
-
2 - authenticate using API keys and impersonate a real User with Super Admin privileges.
20
-
21
-
We recommend impersonating a Super Admin, which allows you to grant Admin privileges to users (service Accounts cannot do this).
19
+
There are two provider authentication methods available:
22
20
23
-
Follow the provider [authentication setup instructions](https://github.com/hashicorp/terraform-provider-googleworkspace/blob/main/docs/index.md#google-workspace-provider).
21
+
1. Authenticate a Google Cloud service account via API keys.
22
+
2. Authenticate a Google Cloud service account via API keys and impersonate a real user with Super Admin privileges.
24
23
25
-
<!-- TODO(weston) - provide step by step instructions for setting this up -->
24
+
We recommend method (2), impersonating a Super Admin, as this allows you to grant Admin privileges to users (service accounts cannot do this). To set this up, follow the [Domain-Wide Delegation authentication instructions](https://github.com/hashicorp/terraform-provider-googleworkspace/blob/main/docs/index.md#using-domain-wide-delegation).
26
25
27
-
Once you've finished the setup process, your provider block should look like this,
26
+
Once you've completed the setup process, your provider block should look like this:
28
27
29
28
```hcl
30
29
provider "googleworkspace" {
31
-
# use 'my_customer', which is an alias that Google's API recognizes to reference your account's customerId.
32
-
# For example - Custom Schemas on the user object will fail if the customer_id is set to your actual customer_id.
33
-
# For more details see: https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas/get
30
+
# Use 'my_customer', which is an alias recognized by Google's API to reference your account's customerId.
31
+
# For example, custom schemas on the user object will fail if the customer_id is set to your actual customer_id.
32
+
# For more details, see: https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas/get
0 commit comments