Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit 862d878

Browse files
committed
fix: update links to repo and pull in edits from masterpointio/terraform-googleworkspace-users-groups-automation#5
1 parent 5c21ab0 commit 862d878

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

.github/workflows/test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ jobs:
2525
with:
2626
tf_type: ${{ matrix.tf }}
2727
aws_role_arn: ${{ vars.TF_TEST_AWS_ROLE_ARN }}
28-
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,28 @@
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.
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:
2220

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

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).
2625

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:
2827

2928
```hcl
3029
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
3433
customer_id = "my_customer"
3534
3635
credentials = "/path/to/credentials/my-google-project-credentials-1234567890.json"
@@ -50,7 +49,7 @@ provider "googleworkspace" {
5049

5150
```hcl
5251
module "googleworkspace_users_groups" {
53-
source = "git::https://github.com/masterpointio/terraform-googleworkspace-users-groups-automation.git"
52+
source = "git::https://github.com/masterpointio/terraform-users-groups-automation-googleworkspace.git"
5453
5554
users = {
5655
@@ -198,8 +197,8 @@ Copyright © 2016-2025 [Masterpoint Consulting LLC](https://masterpoint.io/)
198197
[newsletter-url]: https://newsletter.masterpoint.io/
199198
[youtube-badge]: https://img.shields.io/badge/YouTube-Subscribe-D191BF?style=for-the-badge&logo=youtube&logoColor=white
200199
[youtube-url]: https://www.youtube.com/channel/UCeeDaO2NREVlPy9Plqx-9JQ
201-
[release-badge]: https://img.shields.io/github/v/release/masterpointio/terraform-googleworkspace-users-groups-automation?color=0E383A&label=Release&style=for-the-badge&logo=github&logoColor=white
202-
[latest-release]: https://github.com/masterpointio/terraform-googleworkspace-users-groups-automation/releases/latest
203-
[contributors-image]: https://contrib.rocks/image?repo=masterpointio/terraform-googleworkspace-users-groups-automation
204-
[contributors-url]: https://github.com/masterpointio/terraform-googleworkspace-users-groups-automation/graphs/contributors
205-
[issues-url]: https://github.com/masterpointio/terraform-googleworkspace-users-groups-automation/issues
200+
[release-badge]: https://img.shields.io/github/v/release/masterpointio/terraform-users-groups-automation-googleworkspace?color=0E383A&label=Release&style=for-the-badge&logo=github&logoColor=white
201+
[latest-release]: https://github.com/masterpointio/terraform-users-groups-automation-googleworkspace/releases/latest
202+
[contributors-image]: https://contrib.rocks/image?repo=masterpointio/terraform-users-groups-automation-googleworkspace
203+
[contributors-url]: https://github.com/masterpointio/terraform-users-groups-automation-googleworkspace/graphs/contributors
204+
[issues-url]: https://github.com/masterpointio/terraform-users-groups-automation-googleworkspace/issues

0 commit comments

Comments
 (0)