List

Returns the rules in the access control list for the calendar

5 variables
12 variables

Returns the rules in the access control list for the calendar

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • See, edit, share, and permanently delete all the calendars you can access using Google Calendar

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

calendarId STRING Required

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

maxResults INTEGER

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

pageToken STRING

Token specifying which result page to return. Optional

showDeleted BOOLEAN

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

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

Output

This building block provides 12 output parameters

  = Parameter name
  = Format

etag STRING

ETag of the collection

items[] OBJECT

items[].etag STRING

ETag of the resource

items[].id STRING

Identifier of the ACL rule

items[].kind STRING

Type of the resource ("calendar#aclRule")

items[].role STRING

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.
  • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

items[].scope OBJECT

The scope of the rule

items[].scope.type STRING

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.

items[].scope.value STRING

The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default"

kind STRING

Type of the collection ("calendar#acl")

nextPageToken STRING

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

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