# Google Workspace: Managing Access to Google Groups

In this tutorial, you'll learn how to configure [Key Concepts](/how-abbey-works/concepts.md#grant-kits) to automate access requests to an Google Workspace Group by attaching a Google Workspace Group Membership. This use case models granting new users memberships to a Google Workspace group.

The main terraform resources we'll be using for Google Workspace are:

```hcl
googleworkspace_group
googleworkspace_group_member
```

We will be using the [Google Workspace Starter Kit](https://github.com/abbeylabs/abbey-starter-kit-google-workspace-groups) as a base and replace configuration stubs for our use case.

## Before you start

1. **Make sure you have:**
   * An [Abbey account](https://app.abbey.so/sign-up)
   * An [Abbey API Token](/admin/managing-api-tokens.md#creating-new-api-tokens)
   * A GCP account
   * Access to your organization's [Google Workspace admin portal](https://admin.google.com)
2. **Make sure you setup:**
   1. A [Google Workspace Starter Kit](https://github.com/hatim-khan/abbey-example-google-workspace-groups) by following [Get a Starter Kit](/build-a-grant-kit/get-a-starter-kit.md)
   2. A Connection to a repo by following [Connect a Repo](/build-a-grant-kit/connect-a-repo.md)

## Step 1: Configure Your Grant Kit

### Configure Output

Grant Kits rely on your GitHub account and repository name to output access changes, which we'll set through Terraform local variables. Update the `locals` block in `main.tf` with your `account_name` and `repo_name`

{% code title="main.tf" %}

```hcl
 locals {
  account_name = "" #CHANGEME
  repo_name = "" #CHANGEME
  ...
}
```

{% endcode %}

### Configure Reviewers

Workflow defines who should approve an access request. 

Let's update the `reviewers` block by adding yourself as the reviewer by switching `replace-me@example.com` with the email address you use to sign into Abbey. 

{% code title="main.tf" %}

```diff
 resource "abbey_grant_kit" "..." {
   ...
   workflow = {
     steps = [
       {
         reviewers = {
-          one_of = ["replace-me@example.com"] # CHANGEME
+          one_of = ["alice@example.com"]
```

{% endcode %}

## Step 2: Link GSuite with Abbey

Now you'll need to link [GSuite with Abbey](https://developers.abbey.io/#operation/createAppData). 

{% code title="" %}

```diff
curl -X POST \
  -H "Authorization: Bearer $ABBEY_API_TOKEN" \
  -H 'Content-Type: application/json' \
  https://api.abbey.io/v1/users/<user_id>/apps \
  -d '{"type": "googleworkspace", "data": {"email": "<your Google Workspace email>"}}'
```

{% endcode %}

## Step 3: Configure Google Workspace for Terraform

### **Configure Google Workspace Customer ID**

Navigate to <https://admin.google.com/ac/accountsettings/profile> and copy the **Customer ID** under your profile.

<figure><img src="/files/kPUNoxYJ9MAK4rKjkDzO" alt=""><figcaption></figcaption></figure>

Update the value for `google_customer_id` in the locals block with that value

{% code title="main.tf" lineNumbers="true" %}

```diff
locals {
  ...
-  google_customer_id = "$replace-me-with-gcp-customer-id"
+  google_customer_id = "C1111111"
}
```

{% endcode %}

## Step 4: Configure Google Workspace Permissions

{% hint style="info" %}
In this step we will

* Create or use an existing GCP service account
* Give our GCP service account admin role in Google Workspace
* Add Repository Secrets so Github Actions to make calls to GCP
  {% endhint %}

### Setting up the Service Account

Make sure that the **Admin SDK API** and is enabled for your project. You can check by navigating to <https://console.cloud.google.com/apis/api/admin.googleapis.com>.

If you don't already have a service account, create one via <https://console.cloud.google.com/iam-admin/serviceaccounts> with owner role. Keep track of the service account email address, it should something like google-workspace-groups-demo@\<project-id>.iam.gserviceaccount.com.&#x20;

Once you have a service account, create a new Key through the console

<figure><img src="/files/RzQ1vsiKtmKDitLTzqVi" alt=""><figcaption></figcaption></figure>

Save the JSON file, we'll be using the contents later with Github Actions.

### Linking the Service Account to Google Workspace

Navigate to the [Google Workspace Admin Portal](https://admin.google.com/) and go to Account -> Admin Roles.

<figure><img src="/files/4wsfS1a280e8Yfx7LsVa" alt=""><figcaption></figcaption></figure>

Hover on the Groups Admin row and click on **Assign Admin**. It'll open up to a new page:

<figure><img src="/files/f0TRWSzdntoi9CuQLdOi" alt=""><figcaption></figcaption></figure>

Now, click on **Assign service accounts** and enter in the service account email address from the earlier step. Confirm assigning the role and now your service account has access to the Google Workspace groups APIs :tada:

Next, add the following repository secrets so Github Actions can access these credentials.

1. `GOOGLE_CREDENTIALS` - copy paste the contents from the credentials key JSON as the value.
2. `ABBEY_TOKEN` - API token taken from [**Settings > API Tokens**](https://app.abbey.io/settings/developers)

You can do this via **Github repo page -> Settings -> Secrets and Variables -> Actions -> New Repository Secret** and create with the above names.

<details>

<summary>What should it look like?</summary>

<img src="/files/YYsxETIscBH5Svd39XJ1" alt="" data-size="original">

</details>

## Step 5: Deploy Your Starter Kit

To deploy your Starter Kit, follow instructions from [Deploy Your Grant Kit](/build-a-grant-kit/deploying-your-grant-kit.md).

## Step 6: Automate Access Management

:tada: Congratulations! Abbey is now managing permissions to your Resource for you. :tada:

You can now start requesting and approving access by following the [Request Access](/build-a-grant-kit/requesting-access.md) and [Approve or Deny Access Requests](/build-a-grant-kit/approving-or-denying-access-requests.md) guides.

{% hint style="success" %}
Abbey strives to help you automate and secure access management without being intrusive.

To that end, this Pull Request contains native Terraform HCL code using normal open source Terraform Provider libraries. It represents the permissions change. In this case, it's just a simple creation of a new Terraform Resource.
{% endhint %}

After approving the request, you should be able to see that the user has been added to the google group.

1. Navigate to <https://groups.google.com/all-groups>
2. Select the group you are adding a member to
3. View members

Finally, this starter kit comes with a time-based policy by default, the user will automatically be removed after 1 hour.

<figure><img src="/files/WujU4W4PYO1ympW9ckYa" alt=""><figcaption></figcaption></figure>

## Next Steps

To learn more about what [Resources](/resources/privacy-policy.md) you can configure, try one of our [Step-by-Step Tutorials](/getting-started/tutorials.md).&#x20;

For more information on how Abbey works, visit the [Key Concepts](/how-abbey-works/concepts.md) or [Grant Kits](/reference/grant-kits.md) page.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.abbey.io/getting-started/tutorials/g-suite-managing-access-to-google-groups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.