Google Calendar API

Acl: list

Requires authorization

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.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

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,
  "items": [
    acl Resource
  ]
}
Property name Value Description Notes
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.
items[] list List of rules on the access control list.

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.

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.execute(:api_method => service.acl.list,
                        :parameters => {'calendarId' => 'primary'})
entries = result.data.items
entries.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.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.