/calendars/{calendarId}/acl

GET

acl

Returns the rules in the access control list for the calendar.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.googleapis.com/calendar/v3/calendars//acl'

Response Example

{
  "etag": "string",
  "items": [
    {
      "etag": "string",
      "id": "string",
      "kind": "calendar#aclRule",
      "role": "string",
      "scope": {
        "type": "string",
        "value": "string"
      }
    }
  ],
  "kind": "calendar#acl",
  "nextPageToken": "string",
  "nextSyncToken": "string"
}

Request

Path Params

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.

Query Params

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.

pageToken

string

optional

Token specifying which result page to return. Optional.

showDeleted

string

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.

Responses

🟢200Successful response

application/json

Body

etag

string

optional

ETag of the collection.

items

array[object (AclRule) {5}]

optional

List of rules on the access control list.

etag

string

optional

ETag of the resource.

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.

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

scope

object

optional

The extent to which calendar access is granted by this ACL rule.

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.

/calendars/{calendarId}/clear

/calendars/{calendarId}/acl