CaryvaneHelp
/
EN

Microsoft 365 & Google Workspace

A connector is a customer's SaaS tenant, authorised once, that jobs can then read from. The data is copied out as ordinary files — .eml messages, the documents themselves — into storage the customer owns, incrementally, on a schedule. Connectors are separate from storage targets: a connector is only ever a source.

Paid feature

Connectors are not available on a trial; the tile is greyed in the wizard until the customer is on a paid plan, and becomes active the moment they are.

Microsoft 365 #

Connect the tenant #

  1. Connectors → Microsoft 365 → Connect Microsoft 365. Do this while signed in to the console as a user of the customer whose tenant it is (or with that customer selected), so the connection is recorded against them.
  2. Grant admin consent in the tab that opens, signed in as a Global Administrator of the customer's Microsoft 365 tenant. The permissions are application permissions, read-only for backup and write only for restore, so backups run without any user's credentials and survive that admin leaving.
  3. Refresh the Connectors page. It shows Connected with the date consent was granted. Disconnect from the same place; a customer's Global Admin can also revoke the app from Entra at any time, which stops backups until it is granted again.

Create the backup job #

Jobs → New Job → Back up Microsoft 365. On the From step you pick the tenant, and the step lists it live: Mailboxes, Calendars, Contacts, OneDrive, SharePoint Sites and Teams channels. Calendars and contacts live in the mailbox but are picked separately, so you can keep mail for years without keeping the calendar. Tick what you want, or for each type tick Back up all — including ones created later: the job then re-reads the directory on every run and sweeps in new starters and new sites without anyone editing it.

Choose where it runs — one of the customer's agents, or the Caryvane Cloud Agent so nothing passes through their hardware — the destination storage target, and the interval (every 6 hours by default). The first run is a full copy; every run after that asks Microsoft for what changed since the last one, so a 200-mailbox tenant costs minutes a day, not hours.

What is stored, and where #

ResourceStored asUnder
MailboxOne .eml per message, folders preserved in the catalogue<prefix>/mail/<user>/<year>/
OneDriveThe files, in their folder structure<prefix>/onedrive/<user>/
SharePoint siteThe document libraries' files<prefix>/sharepoint/<site>/
Teams channelMessages as JSON, one file per day, plus attachments<prefix>/teams/<team>/<channel>/
CalendarOne JSON file per event — subject, times, location, organiser and attendees — across every calendar the person owns<prefix>/calendar/<user>/<calendar>/
ContactsOne JSON file per personal contact. The organisation’s directory is not included — that belongs to Entra and comes back with the tenant<prefix>/contacts/<user>/

Because they are plain files, anything that can read the bucket can read the backup; the catalogue the console keeps is what makes them searchable and restorable by item.

Google Workspace #

Connect the domain #

Google Workspace is authorised with domain-wide delegation to Caryvane's service account, granted by the customer's Workspace super-admin. There is no OAuth pop-up: the customer authorises the service account's client ID for a fixed set of read-only scopes in their admin console, once.

  1. Connectors → Google Workspace → Connect Google Workspace. The dialog shows the client ID to authorise and the exact scopes list to paste. Enter the customer's Workspace domain and an admin email to impersonate (any super-admin; used only to list users).
  2. In the customer's Google Admin console: Security → Access and data control → API controls → Manage Domain Wide Delegation (note: Label Manager sits on that same Access and Data Control page and is a different screen entirely). If Caryvane's client ID is already listed, open that entry and edit it — only use Add new if it is not there. Paste the client ID and the whole scopes list.

    Paste the whole list, every time. Google replaces the scopes on that screen rather than adding to them, and says nothing to that effect. Pasting only a newly-required scope removes the others, and the customer's next backup fails on credentials that looked correct when you left the page.

    The list grows when new features need access — Drive labels added drive.labels.readonly in September 2026. A domain authorised before that keeps working for everything except the new part, which looks like a fault rather than a missing grant. If a run reports a missing scope, re-paste the current list and authorise again.

  3. Verify. Back in Caryvane, Re-verify tries each scope against the domain and names any that is missing. Verified with a date means backups can run.

Create the backup job #

Jobs → New Job → Back up Google Workspace; the domain is picked on the From step. Per user: Gmail, Google Drive, Calendar, Contacts; and the domain's Shared Drives. The same all — including ones created later switch, the same choice of agent or Cloud Agent, the same interval. Gmail is stored as .eml under <prefix>/gmail/<user>/<year>/; Drive files under <prefix>/drive/<user>/ with Google-native documents exported to Office formats; calendars and contacts as standard .ics and .vcf.

Drive labels come across as metadata #

If the customer classifies files with Drive labels, Caryvane imports them alongside the backup and shows them against each file as Label name / Field name. They are read-only in Caryvane, because they belong to Google — change them in Drive and the next run brings the change across. Retention and archiving rules can be written against them exactly as against a SharePoint column, so “archive anything marked Closed Matter” behaves the same whichever system the tag came from.

Where the customer creates them: Admin console → Security → Access and Data Control → Label Manager, as of September 2026. Google has moved this more than once — older guides, including Google's own, point at Apps → Google Workspace → Drive and Docs, where it no longer is.

Rather than trusting any path, including this one: type labels into the search bar at the top of the Admin console, or go straight to drive.google.com/labels. Both survive the next reshuffle. If neither finds it, the cause is the edition or a missing Manage Labels admin privilege — not the menu.

Three things make the difference between labels appearing and a run that looks broken. The label must be published — drafts are never returned. It must have at least one field; a label with only a name and description imports as a column with no values. And the domain needs Business Standard or above, as labels do not exist on Business Starter.

A domain that has not granted drive.labels.readonly backs up normally but imports no labels, and says so in the run rather than quietly reporting none found — “no labels here” and “you have not authorised us to look” need opposite responses, so they are never reported the same way.

Archive a leaver #

When someone leaves, the licence goes and with it the mailbox — thirty days later, silently. The archive is a one-off snapshot of one person taken before that: Connectors → Office Archive → New Archive (or Google Workspace Archive). Choose the person, tick mailbox and/or OneDrive/Drive (and any SharePoint sites they owned), the storage target, and whether it runs on an agent or the Cloud Agent. The result is a set of ZIP files, catalogued and listed under Archives with their size and date, downloadable from the console for as long as the customer keeps them. An archive that stops carries on from its last stored part. It never deletes anything from Microsoft or Google; removing the account is the customer's step, taken afterwards.

Restore items #

On the job: ⋮ → Browse backup. Search or browse to the item; Download it, or Restore to original to put a message back in the mailbox or a file back in the drive at its original path. Teams messages are download-only. Details in Restore data.

Export a mailbox to PST #

Mail the backup already holds can be turned into PST files that open in Outlook — a whole mailbox, one folder, or only mail older than an age — without touching the backup. On the job: ⋮ → Browse backup, pick the mailbox or a folder under it, Export to PST. The console shows how many messages and about how big before anything starts; the files go to a folder on one of the customer's machines or to a storage target. It is optional, on demand, and for Manager and above. Details in Export to PST.

Things to know #

Go deeper #