REST Resource: groups

Ressource: Group

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 qui est imité par un compte de service) doit disposer d'un rôle qui inclut des autorisations d'administrateur des groupes d'API, comme super-administrateur ou administrateur de 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

string

Lecture seule. Identifiant unique d'un groupe. Un id de groupe peut être utilisé comme groupKey d'un URI de requête de groupe.
email

string

Adresse e-mail du groupe. Si votre compte comporte plusieurs domaines, sélectionnez le domaine approprié pour l'adresse e-mail. Le email doit être unique. Cette propriété est obligatoire lors de la création d'un groupe. Les adresses e-mail de groupe sont soumises aux mêmes règles d'utilisation des caractères que les noms d'utilisateur. Pour en savoir plus, consultez le Centre d'aide.
name

string

Nom à afficher du groupe.
description

string

Description étendue pour aider les utilisateurs à déterminer l'objectif d'un groupe. Vous pouvez par exemple inclure des informations sur les utilisateurs qu'il cible, le type de messages à lui envoyer, des liens vers les questions fréquentes relatives au groupe ou le nom de groupes similaires. Le nom de l'environnement ne peut pas comporter plus de 4,096 caractères.
adminCreated

boolean

Lecture seule. La valeur est true si ce groupe a été créé par un administrateur plutôt qu'un utilisateur.
directMembersCount

string (int64 format)

Nombre d'utilisateurs qui sont des membres directs du groupe. Si un groupe est membre (enfant) de ce groupe (le parent), les membres du groupe enfant ne sont pas comptabilisés dans la propriété directMembersCount du groupe parent.
kind

string

Type de la ressource d'API. Pour les ressources Groups, la valeur est admin#directory#group.
etag

string

ETag de la ressource.
aliases[]

string

Lecture seule. Liste des adresses e-mail d'alias d'un groupe. Pour ajouter, modifier ou supprimer les alias d'un groupe, utilisez les méthodes groups.aliases. Si vous modifiez cette valeur dans la requête POST ou PUT d'un groupe, la modification est ignorée.
nonEditableAliases[]

string

Lecture seule. Liste des adresses e-mail d'alias non modifiables du groupe qui se trouvent en dehors du domaine principal ou des 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. Si vous modifiez cette valeur dans la requête POST ou PUT d'un groupe, la modification est ignorée.

Méthodes

delete

 Supprime un groupe.

get

 Récupère les propriétés d'un groupe.

insert

 Crée un groupe.

list

 Récupère tous les groupes d'un domaine ou d'un utilisateur à l'aide d'une clé utilisateur (mise en page).

patch

 Met à jour les propriétés d'un groupe.

update

 Met à jour les propriétés d'un groupe.