Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-133839143.7 KB
acl

Updates an access control rule. This method supports patch semantics.

patch/calendars/{calendarId}/acl/{ruleId}

Path parameters

calendarIdstring 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.

ruleIdstring required

ACL rule identifier.

Query parameters

sendNotificationsboolean

Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

Request body

idstring

Identifier of the Access Control List (ACL) rule. See Sharing calendars.

rolestring

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.
etagstring

ETag of the resource.

kindstring

Type of the resource ("calendar#aclRule").

Response

Successful response