Acl: insert

Crée une règle de contrôle des accès. Essayez maintenant ou consultez un exemple.

Requête

Requête HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/acl

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".
Paramètres de requête facultatifs
sendNotifications boolean Permet d'indiquer si vous souhaitez envoyer des notifications en cas de modification du partage d'agenda. Facultatif. La valeur par défaut est "True".

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant:

Définition du champ d'application
https://www.googleapis.com/auth/calendar

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 de LCA avec les propriétés suivantes:

Nom de propriété Valeur Description Remarques
Propriétés obligatoires
role string Rôle attribué au champ d'application. Les valeurs possibles sont:
  • "none" : aucun accès.
  • "freeBusyReader" : fournit un accès en lecture aux informations de disponibilité.
  • "reader" : fournit un accès en lecture à l'agenda. Les événements privés seront visibles par les utilisateurs disposant d'un accès en lecture, mais les détails les concernant seront masqués.
  • "writer" : fournit un accès en lecture et en écriture à l'agenda. Les événements privés seront visibles par les utilisateurs autorisés à écrire, et les détails les concernant seront visibles.
  • "owner" : indique la propriété de l'agenda. Ce rôle dispose de toutes les autorisations du rôle de rédacteur, mais il peut également afficher et manipuler les LCA.
accessible en écriture
scope object Le degré d'accès à l'agenda accordé par cette règle LCA.
scope.type string Type de champ d'application. Les valeurs possibles sont:
  • "default" : champ d'application public. 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, authentifiés ou non.
Propriétés facultatives
scope.value string Adresse e-mail d'un utilisateur ou d'un groupe, ou nom d'un domaine, en fonction du type de champ d'application. Omis pour le type "default". accessible en écriture

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource de LCA dans le corps de la réponse.

Exemples

Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).

Java

Utilise la bibliothèque cliente Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.AclRule;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create access rule with associated scope
AclRule rule = new AclRule();
Scope scope = new Scope();
scope.setType("scopeType").setValue("scopeValue");
rule.setScope(scope).setRole("role");

// Insert new access rule
AclRule createdRule = service.acl().insert('primary', rule).execute();
System.out.println(createdRule.getId());

Python

Utilise la bibliothèque cliente Python.

rule = {
    'scope': {
        'type': 'scopeType',
        'value': 'scopeEmail',
    },
    'role': 'role'
}

created_rule = service.acl().insert(calendarId='primary', body=rule).execute()

print created_rule['id']

PHP

Utilise la bibliothèque cliente PHP.

$rule = new Google_Service_Calendar_AclRule();
$scope = new Google_Service_Calendar_AclRuleScope();

$scope->setType("scopeType");
$scope->setValue("scopeValue");
$rule->setScope($scope);
$rule->setRole("role");

$createdRule = $service->acl->insert('primary', $rule);
echo $createdRule->getId();

Ruby

Utilise la bibliothèque cliente Ruby.

rule = Google::Apis::CalendarV3::AclRule.new(
  scope: {
    type: 'scopeType',
    value: 'scopeEmail',
  },
  role: 'role'
)
result = client.insert_acl('primary', rule)
print result.id

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.