Acl: list

Returns the rules in the access control list for the calendar. Try it now or see an example.

Request

HTTP request

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl

Parameters

Parameter name	Value	Description
Path parameters
`calendarId`	`string`	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.
Optional query parameters
`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.

Authorization

This request requires authorization with the following scope:

Scope
`https://www.googleapis.com/auth/calendar`

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "calendar#acl",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    acl Resource
  ]
}

Property name	Value	Description
`kind`	`string`	Type of the collection ("`calendar#acl`").
`etag`	`etag`	ETag of the collection.
`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.
`items[]`	`list`	List of rules on the access control list.
`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.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Acl;
import com.google.api.services.calendar.model.AclRule;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over a list of access rules
Acl acl = service.acl().list('primary').execute();

for (AclRule rule : acl.getItems()) {
  System.out.println(rule.getId() + ": " + rule.getRole());
}

Python

Uses the Python client library.

acl = service.acl().list(calendarId='primary').execute()

for rule in acl['items']:
  print '%s: %s' % (rule['id'], rule['role'])

PHP

Uses the PHP client library.

$acl = $service->acl->listAcl('primary');

foreach ($acl->getItems() as $rule) {
  echo $rule->getId() . ': ' . $rule->getRole();
}

Ruby

Uses the Ruby client library.

result = client.list_acls('primary')
result.items.each do |e|
  print e.id + ": " + e.role + "\n"
end

Try it!

Use the APIs Explorer below to call this method on live data and see the response.