Gérer les groupes

Cette page explique comment gérer Google Groupes avec l'API Directory:

  • Créer un groupe
  • Mettre à jour un groupe
  • Ajouter un alias de groupe
  • Récupérer un groupe
  • Récupérer tous les groupes d'un domaine ou du compte
  • Récupérer tous les groupes d'un membre
  • Récupérer tous les alias de groupe
  • Supprimer un alias de groupe
  • Supprimer un groupe

Créer un groupe

Pour créer un groupe, utilisez la requête POST suivante et incluez l'autorisation décrits dans Autoriser les requêtes Vous pouvez créer un groupe pour n'importe quel domaine associé au compte. Pour les chaînes de requête, demandez, et les propriétés de réponse, consultez la Méthode groups.insert. 

POST https://admin.googleapis.com/admin/directory/v1/groups

La requête JSON suivante présente un exemple de corps de requête permettant de créer un groupe. Adresse e-mail du groupe l'adresse est sales_group@example.com: 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Une réponse positive renvoie une Code d'état HTTP 201 et les propriétés du nouveau groupe.

Mettre à jour un groupe

Pour mettre à jour les paramètres d'un groupe, utilisez la requête PUT suivante et incluez les l'autorisation décrite dans Autoriser les requêtes groupKey est l'adresse e-mail du groupe, toute adresse e-mail de l'alias du groupe, ou l'attribut id unique du groupe. Pour les chaînes de requête, les propriétés de requête et de réponse, consultez les Méthode groups.update. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey

En règle générale, Google recommande de ne pas utiliser l'adresse e-mail du groupe comme clé pour les données persistantes. car l'adresse e-mail est susceptible d'être modifiée.

Dans l'exemple suivant, l'unique groupKey est nnn et l'attribut Le nom est APAC Sales Group: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

Pour une demande de mise à jour, il vous suffit d'envoyer les informations mises à jour dans votre demande. Vous ne devez pas saisir toutes les propriétés du groupe dans la demande.

Une réponse positive renvoie une Code d'état HTTP 201 et les propriétés du nouveau groupe: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Ajouter un alias de groupe

Pour ajouter un alias de groupe, utilisez la requête POST suivante et incluez l'autorisation décrit dans la section Autoriser les requêtes. groupKey est l'adresse e-mail du groupe, tout alias de groupe adresse e-mail ou le id unique du groupe. Pour en savoir plus sur les chaînes de requête, ainsi que les propriétés de requête et de réponse, consultez la section la ressource groups. 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

En général, Google recommande de ne pas utiliser l'adresse e-mail du groupe comme clé pour les données persistantes. car l'adresse e-mail est susceptible d'être modifiée.

La requête JSON suivante présente un exemple de requête permettant de créer l'alias d'un groupe. La groupKey est l'id unique du groupe, représenté par NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Une réponse positive renvoie une Code d'état HTTP 201 et les propriétés du nouvel alias de groupe.

Récupérer un groupe

Pour récupérer un groupe, utilisez la requête GET suivante et incluez l'autorisation décrits dans Autoriser les requêtes groupKey est l'adresse e-mail du groupe, tout alias de groupe adresse e-mail ou le id unique du groupe. Pour en savoir plus sur les chaînes de requête, ainsi que les propriétés de requête et de réponse, consultez la section la méthode groups.get. 
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

En général, Google recommande de ne pas utiliser l'adresse e-mail du groupe comme clé pour les données persistantes. car l'adresse e-mail est susceptible d'être modifiée.

Dans l'exemple suivant, l'ID groupKey unique est nnnn: 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Une réponse positive renvoie une Code d'état HTTP 200 et les paramètres du groupe: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Récupérer tous les groupes d'un domaine ou du compte

Pour récupérer tous les groupes d'un domaine spécifique ou du compte, utilisez l'GET suivant demande et incluez l'autorisation décrite dans Autoriser les requêtes Pour la requête de requête et de réponse, consultez la Méthode groups.list. Pour faciliter la lecture, cet exemple utilise des retours à la ligne: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Lorsque vous récupérez tous les groupes d'un domaine ou d'un compte, tenez compte des points suivants:

  • Tous les groupes d'un sous-domaine: utilisez l'argument domain avec le nom du domaine.
  • Tous les groupes du compte: utilisez l'argument customer avec au choix my_customer ou la valeur customerId du compte. En tant que compte administrateur, utilisez la chaîne my_customer pour représenter l'adresse e-mail customerId Si vous êtes un revendeur et que vous accédez au compte d'un client indirect, utilisez le customerId du compte indirect. Pour la valeur customerId, utilisez la méthode le nom de domaine principal du compte Récupérer tous les utilisateurs d'un domaine à la requête de l'opération. La réponse obtenue contient la valeur customerId.
  • Avec les arguments domain et customer : L'API Directory renvoie tous les groupes pour domain.
  • Sans les arguments domain et customer : L'API Directory renvoie tous les groupes du compte associé à my_customer Il s'agit du compte customerId de l'administrateur qui effectue la demande.
  • Avec les arguments customer et userKey : L'API Directory renvoie une erreur. Vous devez envoyer deux requêtes distinctes avec ces .

Dans l'exemple suivant, un administrateur de compte utilise my_customer pour demander la liste de tous groupes d'un compte:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

Dans l'exemple suivant, la requête d'un administrateur de revendeur renvoie tous les groupes pour le compte revendu. avec customerId C03az79cb. Le nombre maximal de résultats renvoyés par page de réponse est de 2. Il existe un nextPageToken pour la liste d'utilisateurs suivante dans cette réponse: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Une réponse positive renvoie une Code d'état HTTP 200 et les groupes par ordre alphabétique de l'adresse e-mail de groupe: 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Récupérer tous les groupes d'un membre

Pour récupérer tous les groupes auxquels un membre dispose d'un abonnement, utilisez l'GET suivant demande et incluez l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, Cet exemple utilise des retours à la ligne: 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page
  • Un membre peut être un utilisateur ou un groupe.
  • userKey peut être l'adresse e-mail principale de l'utilisateur, son alias d'adresse e-mail, l'adresse e-mail principale d'un groupe, l'alias d'adresse e-mail d'un groupe ou le id unique de l'utilisateur disponible à l'aide du Récupérer une opération utilisateur
  • L'utilisateur ou le groupe spécifié dans userKey doit appartenir à votre domaine.
  • Utilisez la chaîne de requête pageToken pour les réponses comportant un grand nombre de groupes. Dans en cas de pagination, la réponse renvoie la propriété nextPageToken, qui donne pour la page suivante des résultats de réponse. Votre prochaine requête utilise ce jeton comme Valeur de la chaîne de requête pageToken.
  • Avec les arguments customer et userKey : L'API Directory renvoie une erreur. Vous devez envoyer deux requêtes distinctes avec ces .

Pour les propriétés de requête et de réponse, consultez les Méthode groups.list.

Une réponse positive renvoie une Code d'état HTTP 200 et la liste des informations sur les membres:

  • Tous les groupes auxquels un membre est abonné, y compris les groupes extérieurs au domaine domaine, sont renvoyés.
  • Les groupes sont renvoyés dans l'ordre alphabétique de leur adresse e-mail.
  • Dans le corps de la réponse, id est l'identifiant unique du groupe.
  • Dans la réponse, l'affichage d'un groupe extérieur au domaine de l'utilisateur n'inclut pas le paramètre en dehors des alias du groupe. 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Récupérer tous les alias de groupe

Pour récupérer tous les alias d'un groupe, utilisez la requête GET suivante et incluez les l'autorisation décrite dans Autoriser les requêtes La groupKey peut être l'adresse e-mail principale du groupe, son identifiant unique id ou les alias de groupe e-mails. Pour les propriétés de requête et de réponse, consultez la ressource groups. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Une réponse positive renvoie une Code d'état HTTP 201 et une liste des alias du groupe.

Supprimer un alias de groupe

Pour supprimer l'alias d'un groupe, utilisez la requête DELETE suivante et incluez les l'autorisation décrite dans Autoriser les requêtes L'adresse e-mail principale (groupKey) peut être l'adresse e-mail principale du groupe, id ou les alias de groupe e-mails. aliasId est l'alias supprimés. Pour les propriétés de requête et de réponse, consultez la ressource groups: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Une réponse positive renvoie une Code d'état HTTP 201.

Supprimer un groupe

Pour supprimer un groupe, utilisez la requête DELETE suivante et incluez l'autorisation décrits dans Autoriser les requêtes groupKey est le id unique du groupe: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
 Par exemple, cette requête DELETE supprime le groupe contenant le groupe nnnn id: 
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Une réponse positive renvoie une Code d'état HTTP 200.

Voici ce qui se produit lorsqu'un groupe est supprimé:

  • Tous les membres du groupe sont supprimés. Les comptes utilisateur du membre ne sont pas supprimés.
  • L'archive du groupe est supprimée.
  • Les messages envoyés à l'adresse du groupe supprimé ne sont plus distribués. Au lieu de cela, l'expéditeur reçoit un message d'erreur automatique.