Skip to content

Commit 3faa656

Browse files
committed
1 parent 20162d8 commit 3faa656

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,29 @@
88

99
## Purpose and Functionality
1010

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.
1214

1315
## Usage
1416

1517
### Step-by-Step Instructions
1618

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.
19+
There are two provider authentication methods available:
20+
1. Authenticate using a Google Cloud service account key file.
21+
2. Authenticate using a Google Cloud service account key file and impersonate a real user with Super Admin privileges.
2022

21-
We recommend impersonating a Super Admin, which allows you to grant Admin privileges to users (service Accounts cannot do this).
23+
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).
2224

2325
Follow the provider [authentication setup instructions](https://github.com/hashicorp/terraform-provider-googleworkspace/blob/main/docs/index.md#google-workspace-provider).
2426

25-
Once you've finished the setup process, your provider block should look like this,
27+
Once you've completed the setup process, your provider block should look like this:
2628

2729
```hcl
2830
provider "googleworkspace" {
29-
# use 'my_customer', which is an alias that Google's API recognizes to reference your account's customerId.
30-
# User Custom Schemas (googleworkspace_user.custom_schemas) will fail if the customer_id is set to your actual customer_id.
31-
# For more details see: https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas/get
31+
# Use 'my_customer' as an alias for your account's customerId to ensure compatibility with Google's API
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: https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas/get
3234
customer_id = "my_customer"
3335
3436
credentials = "/path/to/credentials/my-google-project-credentials-1234567890.json"

0 commit comments

Comments
 (0)