REST Resource: groups
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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 |
|
|
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 à l'aide d'une clé utilisateur (mise en page). |
|
|
Met à jour les propriétés d'un groupe. |
|
|
Met à jour les propriétés d'un groupe. |
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/24 (UTC).
[null,null,["Dernière mise à jour le 2025/07/24 (UTC)."],[],[],null,["# REST Resource: groups\n\nResource: Group\n---------------\n\nGoogle Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups).\n\nFor information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups).\n\nNote: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"email\": string, \"name\": string, \"description\": string, \"adminCreated\": boolean, \"directMembersCount\": string, \"kind\": string, \"etag\": string, \"aliases\": [ string ], \"nonEditableAliases\": [ string ] } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. |\n| `email` | `string` The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. |\n| `name` | `string` The group's display name. |\n| `description` | `string` An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. |\n| `adminCreated` | `boolean` Read-only. Value is `true` if this group was created by an administrator rather than a user. |\n| `directMembersCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. |\n| `kind` | `string` The type of the API resource. For Groups resources, the value is `admin#directory#group`. |\n| `etag` | `string` ETag of the resource. |\n| `aliases[]` | `string` Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored. |\n| `nonEditableAliases[]` | `string` Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| ### [delete](/workspace/admin/directory/reference/rest/v1/groups/delete) | Deletes a group. |\n| ### [get](/workspace/admin/directory/reference/rest/v1/groups/get) | Retrieves a group's properties. |\n| ### [insert](/workspace/admin/directory/reference/rest/v1/groups/insert) | Creates a group. |\n| ### [list](/workspace/admin/directory/reference/rest/v1/groups/list) | Retrieves all groups of a domain or of a user given a userKey (paginated). |\n| ### [patch](/workspace/admin/directory/reference/rest/v1/groups/patch) | Updates a group's properties. |\n| ### [update](/workspace/admin/directory/reference/rest/v1/groups/update) | Updates a group's properties. |"]]
