Ressource: Groupe
Google Groupes permet à vos utilisateurs d'envoyer des messages à des groupes de personnes à l'aide de l'adresse e-mail du groupe. Pour en savoir plus sur les tâches courantes, consultez le guide du développeur.
Pour en savoir plus sur les autres types de groupes, consultez la documentation de l'API Cloud Identity Groups.
Remarque: L'utilisateur qui appelle l'API (ou dont l'identité a été empruntée par un compte de service) doit disposer d'un rôle qui inclut les autorisations des groupes de l'API Admin (par exemple, Super-administrateur ou Administrateur des groupes).
Représentation JSON |
---|
{ "id": string, "email": string, "name": string, "description": string, "adminCreated": boolean, "directMembersCount": string, "kind": string, "etag": string, "aliases": [ string ], "nonEditableAliases": [ string ] } |
Champs | |
---|---|
id |
En lecture seule. Identifiant unique d'un groupe. Un |
email |
Adresse e-mail du groupe. Si votre compte comporte plusieurs domaines, sélectionnez le domaine approprié pour l'adresse e-mail. L'élément |
name |
Nom à afficher du groupe |
description |
Description étendue pour aider les utilisateurs à déterminer l'objectif d'un groupe. Par exemple, vous pouvez inclure des informations sur les personnes autorisées à rejoindre le groupe, les types de messages à envoyer au groupe, des liens vers des questions fréquentes sur le groupe ou des groupes similaires. Le nom de l'environnement ne peut pas comporter plus de |
adminCreated |
En lecture seule. La valeur est |
directMembersCount |
Nombre d'utilisateurs qui sont des membres directs du groupe. Si un groupe est membre (enfant) de ce groupe (le parent), les membres du sous-groupe ne sont pas comptabilisés dans la propriété |
kind |
Type de ressource d'API. Pour les ressources Groupes, la valeur est |
etag |
ETag de la ressource. |
aliases[] |
En lecture seule. Liste des alias d'adresses e-mail d'un groupe. Pour ajouter, mettre à jour ou supprimer des alias de groupe, utilisez les méthodes |
nonEditableAliases[] |
En lecture seule. Liste des alias d'adresses e-mail non modifiables du groupe qui sont extérieurs au domaine principal ou aux sous-domaines du compte. Il s'agit d'adresses e-mail fonctionnelles utilisées par le groupe. Il s'agit d'une propriété en lecture seule renvoyée dans la réponse de l'API pour un groupe. Toute modification effectuée dans une requête POST ou PUT d'un groupe est ignorée. |
Méthodes |
|
---|---|
|
Supprime un groupe. |
|
Récupère les propriétés d'un groupe. |
|
Crée un groupe. |
|
Récupère tous les groupes d'un domaine ou d'un utilisateur en fonction d'un userKey (paginé). |
|
Met à jour les propriétés d'un groupe. |
|
Met à jour les propriétés d'un groupe. |