Google: Calendar ACL schemas

← Calendar ACL operations · All schemas

Creates an access control rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the resource.
id	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	Required within parent	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.
scope	Model	Required within parent	Expand Creates an access control rule — response body — scope

Referenced models: Creates an access control rule — response body — scope

Creates an access control rule — response body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the resource.
id	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. - "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.
scope	Model	Optional	Expand Creates an access control rule — response body — scope

Referenced models: Creates an access control rule — response body — scope

Creates an access control rule — response body — scope

Field	Type	Presence	Description and constraints
$	object	Root	The extent to which calendar access is granted by this ACL rule.
type	string	Optional	The type of the scope. Possible values are: - "default" - The public scope. This is the default value. - "user" - Limits the scope to a single user. - "group" - Limits the scope to a group. - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
value	string	Optional	The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

Returns the rules in the access control list for the calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the collection.
items	array	Optional	List of rules on the access control list.
items[]	Model	Each item	Expand Creates an access control rule — response body
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.

Referenced models: Creates an access control rule — response body

Updates an access control rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the resource.
id	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. - "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.
scope	Model	Required within parent	Expand Creates an access control rule — response body — scope

Referenced models: Creates an access control rule — response body — scope

Updates an access control rule — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
sendNotifications	boolean	Optional	Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

Watch for changes to ACL resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
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. Format: int32 Minimum: 1
pageToken	string	Optional	Token specifying which result page to return. Optional.
showDeleted	boolean	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.

Watch for changes to ACL resources — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address where notifications are delivered for this channel.
expiration	string	Optional	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Format: int64
id	string	Optional	A UUID or similar unique string that identifies this channel.
kind	string	Optional	Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". Default: api#channel
params	object	Optional	Additional parameters controlling delivery channel behavior. Optional. Additional keys: see wildcard field
params.*	string	Additional keys	Declares a new parameter by name.
payload	boolean	Optional	A Boolean value to indicate whether payload is wanted. Optional.
resourceId	string	Optional	An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
resourceUri	string	Optional	A version-specific identifier for the watched resource.
token	string	Optional	An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
type	string	Optional	The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.