cirrux

Google Workspace migration setup

This guide walks a Google Workspace super-admin through authorizing Cirrux to discover users in their domain and migrate them to a Cirrux workspace in bulk. The setup is a one-time admin task — once authorized, no further per-user consent is required.

This feature is in private beta. If you don’t see the “Google Workspace” card in your Cirrux admin settings, please request access from your Cirrux contact.

Before you start

Prerequisites

  • You are a Google Workspace super-admin on the domain you want to migrate.
  • You are a workspace admin of the Cirrux workspace that will receive the migrated data.
  • Your Cirrux user account has the workspace_migration_v1 tag enabled. Cirrux support will set this for you during onboarding.

What Cirrux will request

The Cirrux Google Workspace app requests the following OAuth scopes:

  • userinfo.email and userinfo.profile— to identify which admin authorized the connection.
  • admin.directory.user.readonly— to list the users in your Workspace so you can map them to Cirrux members.
  • admin.directory.customer.readonly— to read your Workspace organization name and primary domain for display in the Cirrux admin panel.

In a later phase, we will request additional read-only scopes for Gmail, Calendar, and Contacts so individual mailboxes can be migrated. Those scopes will only be requested when you initiate a migration run.

Authorize Cirrux in your Workspace

Step 1: Trust the Cirrux app in your admin console

Google Workspace restricts third-party app access by default. Before Cirrux can call the Directory API on your behalf, you must explicitly trust the Cirrux OAuth client in your Workspace admin console.

  1. Open admin.google.com and sign in as a super-admin.
  2. Navigate to SecurityAccess and data control API controls.
  3. Scroll to App access control and click Manage Third-Party App Access.
  4. Click Add appOAuth App Name Or Client ID.
  5. Paste the Cirrux OAuth client ID (provided by your Cirrux contact) and search.
  6. Select the Cirrux app from the results, then Continue.
  7. Choose Trusted: Can access all Google services. (If you prefer Limited, tick all the scopes listed above — an incomplete scope list will block the connection.)
  8. Apply to your entire domain, review, and confirm.

Changes propagate in a few minutes but can take up to 24 hours in rare cases.

Step 2: Connect from Cirrux

  1. In Cirrux, open SettingsWorkspace Admin.
  2. Find the Google Workspace card and click Connect Google Workspace.
  3. Sign in as the Google Workspace super-admin you used in step 1 and approve the requested scopes.
  4. You’ll be redirected back to the admin page. Within a few seconds, the card should refresh to show your Workspace domain, organization name, and total user count.

Step 3: Verify the connection

A healthy connection shows your domain (e.g. acme.com), the org name pulled from the Workspace directory, and the total Workspace user count. If the user count never populates, see troubleshooting below.

Troubleshooting

Error 400: access_not_configured

You’re seeing the “You don’t have access to this app until an administrator reviews and configures access” screen during step 2.

This means the Workspace admin allowlist step (step 1) hasn’t taken effect for the scopes Cirrux is requesting.

  • Confirm the Cirrux app is listed under API controls → Manage Third-Party App Access and its access is Trusted.
  • If you chose Limited, re-edit and tick every scope listed above, including admin.directory.user.readonly.
  • Wait 5–10 minutes for propagation, then sign out of Google completely (or use an incognito window) and retry the connection.

The user count or org name never populates

The connection succeeds but the card stays empty after a minute or more.

  • The most common cause is that your trusted-app access excludes the Directory API. Re-check step 1 and make sure admin.directory.user.readonly is explicitly authorized (or use Trusted: Can access all Google services).
  • Try disconnecting and reconnecting from the Cirrux admin card.
  • If it still doesn’t resolve, share the connection UUID (shown in the URL of the admin page) with your Cirrux contact so we can inspect server logs.

I don't see the Google Workspace card at all

You’re a Cirrux workspace admin but the card doesn’t render in your admin settings.

  • The feature is gated on the workspace_migration_v1 user tag. Ask your Cirrux contact to enable it for your user.
  • Confirm you are a member of the workspace with the adminrole — not just a regular member.

What happens to my data

Phase 1: read-only directory access

In this phase, Cirrux only reads the user list and basic organization metadata from your Workspace. No mailbox, calendar, or contact data is accessed yet. The admin OAuth token is encrypted at rest in Cirrux’s database and only used to call the Directory API.

You can disconnect at any time from the Cirrux admin card. Disconnecting clears the stored token and revokes the refresh token with Google.