List calendar access rules - Automate.ax

googleCalendar.listAccessRules returns who can access a calendar and at what role, with Google’s page and sync tokens.

Example

import { automation, onDashboardRun } from "automate.ax"
import { googleCalendar } from "automate.ax/google-calendar"

export default automation("Audit calendar sharing", () => {
  onDashboardRun({ title: "Audit calendar sharing" })

  googleCalendar.listAccessRules({ calendar: "Team Calendar", maxResults: 250 })
})

Inputs

calendar defaults to primary. Optional includeDeleted, pageToken, and syncToken control the page. maxResults accepts 1–250. Second argument { account } selects the Google Account.

Output

interface AccessRulePage {
  rules: Array<{
    id: string
    role:
      | "none"
      | "freeBusyReader"
      | "reader"
      | "writerWithoutPrivateAccess"
      | "writer"
      | "owner"
    scope: { type: "default" | "user" | "group" | "domain"; value?: string }
  }>
  nextPageToken?: string
  nextSyncToken?: string
}

Follow all nextPageToken pages before storing nextSyncToken. Do not set includeDeleted: false with syncToken; Google always includes deleted rules during incremental sync.