/calendars/{calendarId}/acl/{ruleId}

PATCH

acl

Updates an access control rule. This method supports patch semantics.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://www.googleapis.com/calendar/v3/calendars//acl/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "etag": "string",
    "id": "string",
    "kind": "calendar#aclRule",
    "role": "string",
    "scope": {
        "type": "string",
        "value": "string"
    }
}'

Response Example

{
  "etag": "string",
  "id": "string",
  "kind": "calendar#aclRule",
  "role": "string",
  "scope": {
    "type": "string",
    "value": "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.

ruleId

string

required

ACL rule identifier.

Query Params

sendNotifications

string

optional

Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

Body Params application/json

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.

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

Examples

Responses

🟢200Successful response

application/json

Body

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.

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

/calendars/{calendarId}/acl/{ruleId}