Acl: update
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Met à jour une règle de contrôle des accès.
Essayer maintenant
Requête
Requête HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/acl/ruleId
Paramètres
Nom du paramètre |
Valeur |
Description |
Paramètres de chemin d'accès |
calendarId |
string |
Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "primary ".
|
ruleId |
string |
Identifiant de la règle LCA.
|
Paramètres de requête facultatifs |
sendNotifications |
boolean |
Indique si des notifications doivent être envoyées concernant le changement de partage du calendrier. Notez qu'aucune notification n'est envoyée lorsque l'accès est supprimé. Facultatif. La valeur par défaut est "True".
|
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:
Champ d'application |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.acls |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, indiquez une ressource Acl avec les propriétés suivantes:
Nom de propriété |
Valeur |
Description |
Remarques |
Propriétés requises |
scope |
object |
Niveau d'accès à l'agenda accordé par cette règle de LCA. |
|
scope.type |
string |
Type de champ d'application. Les valeurs possibles sont les suivantes: - "
default " : portée publique. Il s'agit de la valeur par défaut. - "
user " : limite le champ d'application à un seul utilisateur. - "
group " : limite le champ d'application à un groupe. - "
domain " : limite le champ d'application à un domaine. Remarque: Les autorisations accordées au champ d'application "default ", ou public, s'appliquent à tous les utilisateurs, qu'ils soient authentifiés ou non. |
|
Propriétés facultatives |
role |
string |
Rôle attribué au champ d'application. Les valeurs possibles sont les suivantes: - "
none " : n'accorde aucun accès. - "
freeBusyReader " : permet d'accéder en lecture aux informations de disponibilité. - "
reader " : permet d'accéder en lecture à l'agenda. Les événements privés s'affichent pour les utilisateurs disposant d'un accès lecteur, mais les détails de l'événement sont masqués. - "
writer " : permet d'accéder en lecture et en écriture à l'agenda. Les événements privés s'affichent pour les utilisateurs disposant d'un accès en tant qu'auteur, et leurs détails sont visibles. Fournit un accès en lecture aux ACL de l'agenda. - "
owner " : indique le propriétaire de l'agenda. Ce rôle dispose de toutes les autorisations du rôle d'auteur, avec la possibilité supplémentaire de manipuler les ACL. |
accessible en écriture
|
scope.value |
string |
Adresse e-mail d'un utilisateur ou d'un groupe, ou nom d'un domaine, selon le type de champ d'application. omis pour le type "default ". |
accessible en écriture
|
Réponse
Si la requête aboutit, cette méthode renvoie une ressource Acl dans le corps de la réponse.
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Acl: update\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an access control rule.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/calendar/v3/calendars/calendarId/acl/ruleId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|---------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n| `ruleId` | `string` | ACL rule identifier. |\n| **Optional query parameters** |||\n| `sendNotifications` | `boolean` | Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|-------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.acls` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply an [Acl resource](/workspace/calendar/api/v3/reference/acl#resource) with the following properties:\n\n| Property name | Value | Description | Notes |\n|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|\n| **Required Properties** ||||\n| `scope` | `object` | The extent to which [calendar access](https://developers.google.com/workspace/calendar/concepts/sharing#sharing_calendars) is granted by this ACL rule. | |\n| scope.`type` | `string` | 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. | |\n| **Optional Properties** ||||\n| `role` | `string` | 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. Provides read access to the calendar's ACLs. - \"`owner`\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs. | writable |\n| scope.`value` | `string` | The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"`default`\". | writable |\n\nResponse\n--------\n\nIf successful, this method returns an [Acl resource](/workspace/calendar/api/v3/reference/acl#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]