GOgoogle
acl

GET /calendars/{calendarId}/acl

Changed on

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

Request

  • Base URL
    https://www.googleapis.com/calendar/v3
  • URL
    https://www.googleapis.com/calendar/v3/calendars/{calendarId}/acl
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.acls
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.acls
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.acls.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.acls.readonly

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.

Query parameters

maxResultsinteger

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.

pageTokenstring

Token specifying which result page to return. Optional.

showDeletedboolean

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.

syncTokenstring

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.

Response

Successful response

etagstring

ETag of the collection.

kindstring

Type of the collection ("calendar#acl").

nextPageTokenstring

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

nextSyncTokenstring

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.

Changes

  • 54e6985ee63dRevision changes
    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.acls.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.acls.readonly was removed from the endpoint's security scheme Oauth2c

  • 66a1fabee696Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.acls.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.acls.readonly was removed from the endpoint's security scheme Oauth2c