Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion baton/google-workspace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Set up a Google Workspace connector"
og:title: "Set up a Google Workspace connector"
description: "C1 provides identity governance and just-in-time provisioning for Google Workspace. Integrate your Google Workspace instance with C1 to run user access reviews (UARs) and enable just-in-time access requests."
og:description: "C1 provides identity governance and just-in-time provisioning for Google Workspace. Integrate your Google Workspace instance with C1 to run user access reviews (UARs) and enable just-in-time access requests."

Check warning on line 5 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L5

Did you really mean 'UARs'?
sidebarTitle: "Google Workspace"
---

Expand All @@ -23,24 +23,31 @@

### Connector actions

Connector actions are custom capabilities that extend C1 automations with app-specific operations. You can use connector actions in the [Perform connector action](/product/admin/automations-steps-reference#perform-connector-action) automation step.

Check warning on line 26 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L26

Did you really mean 'automations'?

| Action name | Additional fields | Description |
|-------------|-------------------|-------------|
| update_user_status | `resource_id` (string, required)<br/>`is_suspended` (boolean, required) | Suspends or activates a user account |

Check warning on line 30 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L30

Did you really mean 'update_user_status'?
| disable_user | `user_id` (string, required) | Suspends a user account (idempotent) |

Check warning on line 31 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L31

Did you really mean 'disable_user'?
| enable_user | `user_id` (string, required) | Unsuspends a user account (idempotent) |

Check warning on line 32 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L32

Did you really mean 'enable_user'?

Check warning on line 32 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L32

Did you really mean 'Unsuspends'?
| change_user_primary_email | `resource_id` (string, required)<br/>`new_primary_email` (string, required) | Updates a user's primary email address |

Check warning on line 33 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L33

Did you really mean 'change_user_primary_email'?
| transfer_user_drive_files | `resource_id` (string, required)<br/>`target_resource_id` (string, required)<br/>`privacy_levels` (string, optional) | Transfers Google Drive ownership from one user to another. Accepts `private` or `shared` for privacy_levels |

Check warning on line 34 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L34

Did you really mean 'transfer_user_drive_files'?

Check warning on line 34 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L34

Did you really mean 'privacy_levels'?
| transfer_user_calendar | `resource_id` (string, required)<br/>`target_resource_id` (string, required)<br/>`release_resources` (boolean, optional) | Transfers Google Calendar data from one user to another |

Check warning on line 35 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L35

Did you really mean 'transfer_user_calendar'?
| change_user_org_unit | `user_id` (string, required)<br/>`org_unit_path` (string, required) | Moves a user to a different organizational unit |

Check warning on line 36 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L36

Did you really mean 'change_user_org_unit'?
| offboarding_profile_update | `user_id` (string, required)<br/>`archive_account` (boolean, optional) | Comprehensive offboarding: removes from GAL, clears recovery details, deletes addresses/phones, optionally archives |

Check warning on line 37 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L37

Did you really mean 'offboarding_profile_update'?

Check warning on line 37 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L37

Did you really mean 'offboarding'?
| sign_out_user | `user_id` (string, required) | Signs user out of all sessions and resets sign-in cookies |

Check warning on line 38 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L38

Did you really mean 'sign_out_user'?
| delete_all_oauth_tokens | `user_id` (string, required) | Revokes all third-party app authorizations |

Check warning on line 39 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L39

Did you really mean 'delete_all_oauth_tokens'?
| delete_all_application_passwords | `user_id` (string, required) | Deletes all app-specific passwords |

Check warning on line 40 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L40

Did you really mean 'delete_all_application_passwords'?
| create_group | `email` (string, required)<br/>`name` (string, required)<br/>`description` (string, optional) | Creates a new Google Workspace group |

Check warning on line 41 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L41

Did you really mean 'create_group'?
| modify_group_settings | `group_key` (string, required)<br/>`allow_external_members` (boolean, optional)<br/>`allow_web_posting` (boolean, optional)<br/>`who_can_post_message` (string, optional)<br/>`message_moderation_level` (string, optional) | Update settings for an existing Google Group |

Check warning on line 42 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L42

Did you really mean 'modify_group_settings'?
| update_user_manager | `user_id` (string, required)<br/> `manager_email` (string, required) | Updates the manager relation for a user in Google Workspace. Updates the 'manager' entry in the user's Relations field |

Check warning on line 43 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L43

Did you really mean 'update_user_manager'?
| update_user_profile | `user_id` (resource ID, required)<br/>`given_name` (string, optional)<br/>`family_name` (string, optional)<br/>`recovery_email` (string, optional)<br/>`recovery_phone` (string, optional)<br/>`custom_schemas` (JSON string, optional) | Applies a partial update to a user's profile using patch semantics (only the provided fields change). Supports name fields, recovery details, and custom-schema attribute values. Custom-schema definitions must already exist in the Workspace tenant. At least one updatable field is required. |

Check warning on line 44 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L44

Did you really mean 'update_user_profile'?

Check warning on line 44 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L44

Did you really mean 'updatable'?
| update_user | `user_id` (resource ID, required)<br/>`user_profile` (JSON string, required) | Updates a user's profile from a `user_profile` JSON object (keys: `given_name`, `family_name`, `recovery_email`, `recovery_phone`, `custom_schemas`). Consumed by C1 push rules for automated profile sync. |

Check warning on line 45 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L45

Did you really mean 'update_user'?
| make_admin | `user_id` (resource ID, required)<br/>`status` (boolean, required) | Promotes (`status=true`) or demotes (`status=false`) a user to/from super administrator |

Check warning on line 46 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L46

Did you really mean 'make_admin'?

<Warning>
**Custom-schema limitation:** The `update_user_profile` and `update_user` actions can set custom-schema attribute values, but **deleting a field by sending a `null` value is not supported**. The Google Directory API `users.patch` endpoint silently ignores `null` values in the `customSchemas` payload — the field is not removed. To clear a custom-schema field, update it to an empty string or a sentinel value instead.
</Warning>

## Gather Google Workspace credentials

Expand Down Expand Up @@ -212,7 +219,7 @@
Purpose: (Write) To manage role assignments (grant or revoke roles).

- Scope: https://www.googleapis.com/auth/admin.directory.user <br/>
Purpose: (Write) To provision/deprovision accounts.
Purpose: (Write) To provision/deprovision accounts, update user profiles and custom-schema values, and promote/demote super administrators.

- Scope: https://www.googleapis.com/auth/admin.reports.audit.readonly <br/>
Purpose: To sync usage events and admin events (used in conjunction with continuous sync).
Expand Down Expand Up @@ -276,7 +283,7 @@
<Step>
Choose how to set up the new Google Workspace connector:

- Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren't yet managed with C1)

Check warning on line 286 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L286

Did you really mean 'unmanaged'?

- Add the connector to a managed app (select from the list of existing managed apps)

Expand Down Expand Up @@ -428,7 +435,7 @@

<Steps>
<Step>
Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

Check warning on line 438 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L438

Did you really mean 'namespace'?
</Step>
<Step>
Check that the connector data uploaded correctly. In C1, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the Google Workspace connector to. Google Workspace data should be found on the **Entitlements** and **Accounts** tabs.
Expand All @@ -441,7 +448,7 @@

### What's next?

If Google Workspace is your company's identity provider (meaning that it is used to SSO into other software), the integration sync will automatically create applications in C1 for all of your SCIMed software. Before you move on, review the [Create applications](/product/admin/applications) page for important information about how to set up integrations with the SCIMed apps.

Check warning on line 451 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L451

Did you really mean 'SCIMed'?

Check warning on line 451 in baton/google-workspace.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/google-workspace.mdx#L451

Did you really mean 'SCIMed'?

## Troubleshooting the Google Workspace integration

Expand Down