Google: Returns the rules in the access control list for the calendar

← Calendar ACL operations · Get started

Operation google.calendar_acl_list

Provider route: GET /calendar/v3/calendars/{calendarId}/acl. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["calendarAcl"]["calendarAclList"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendarAcl.calendarAclList(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendar_acl.calendar_acl_list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.calendarId	string	Required within parent	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the “primary” keyword.
query	Model	Optional	Expand Watch for changes to ACL resources — request body — query

Referenced models: Watch for changes to ACL resources — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Returns the rules in the access control list for the calendar — response body

Referenced models: Returns the rules in the access control list for the calendar — response body

Schemas

Returns the rules in the access control list for the calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the collection.
items	array	Optional	List of rules on the access control list.
items[]	Model	Each item	Expand Creates an access control rule — response body
kind	string	Optional	Type of the collection ("calendar#acl"). Default: calendar#acl
nextPageToken	string	Optional	Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
nextSyncToken	string	Optional	Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Referenced models: Creates an access control rule — response body

Watch for changes to ACL resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
maxResults	integer	Optional	Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. Format: int32 Minimum: 1
pageToken	string	Optional	Token specifying which result page to return. Optional.
showDeleted	boolean	Optional	Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
syncToken	string	Optional	Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Creates an access control rule — response body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the resource.
id	string	Optional	Identifier of the Access Control List (ACL) rule. See Sharing calendars.
kind	string	Optional	Type of the resource ("calendar#aclRule"). Default: calendar#aclRule
role	string	Optional	The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.
scope	Model	Optional	Expand Creates an access control rule — response body — scope

Referenced models: Creates an access control rule — response body — scope

Creates an access control rule — response body — scope

Field	Type	Presence	Description and constraints
$	object	Root	The extent to which calendar access is granted by this ACL rule.
type	string	Optional	The type of the scope. Possible values are: - "default" - The public scope. This is the default value. - "user" - Limits the scope to a single user. - "group" - Limits the scope to a group. - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
value	string	Optional	The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

Policy, approvals and errors

SDK function policy ID: google.calendar_acl_list. Catalog operation: calendar.acl.list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls", "https://www.googleapis.com/auth/calendar.acls.readonly"]

Official provider source