REST Resource: groups
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Grupo
Grupos de Google les permite a los usuarios enviar mensajes a grupos de personas con la dirección de correo electrónico del grupo. Para obtener más información sobre las tareas comunes, consulta la Guía para desarrolladores.
Para obtener información sobre otros tipos de grupos, consulta la documentación de la API de Cloud Identity Groups.
Nota: El usuario que llama a la API (o al que una cuenta de servicio suplanta la identidad) debe tener asignado un rol que incluya permisos de grupos de API de administrador, como administrador avanzado o administrador de grupos.
Representación JSON |
{
"id": string,
"email": string,
"name": string,
"description": string,
"adminCreated": boolean,
"directMembersCount": string,
"kind": string,
"etag": string,
"aliases": [
string
],
"nonEditableAliases": [
string
]
} |
Campos |
id |
string
Solo lectura. Es el ID único de un grupo. Se puede usar un id de grupo como groupKey de un URI de solicitud de grupo.
|
email |
string
Es la dirección de correo electrónico del grupo. Si tu cuenta tiene varios dominios, selecciona el dominio correspondiente para la dirección de correo electrónico. El email debe ser único. Esta propiedad es obligatoria cuando se crea un grupo. Las direcciones de correo electrónico de los grupos están sujetas a las mismas reglas de uso de caracteres que los nombres de usuario. Consulta el Centro de ayuda para obtener más información.
|
name |
string
El nombre visible del grupo.
|
description |
string
Es una descripción extendida que ayuda a los usuarios a determinar el propósito de un grupo. Por ejemplo, puedes incluir información sobre quién debe unirse al grupo, los tipos de mensajes que se deben enviar al grupo, vínculos a preguntas frecuentes sobre el grupo o grupos relacionados. La longitud máxima es de 4,096 caracteres.
|
adminCreated |
boolean
Solo lectura. El valor es true si un administrador, en lugar de un usuario, creó este grupo.
|
directMembersCount |
string (int64 format)
Es la cantidad de usuarios que son miembros directos del grupo. Si un grupo es miembro (secundario) de este grupo (el superior), los miembros del grupo secundario no se cuentan en la propiedad directMembersCount del grupo superior.
|
kind |
string
Tipo de recurso de la API. Para los recursos de Grupos, el valor es admin#directory#group .
|
etag |
string
ETag del recurso.
|
aliases[] |
string
Solo lectura. La lista de las direcciones de correo electrónico de alias de un grupo Para agregar, actualizar o quitar los alias de un grupo, usa los métodos groups.aliases . Si se edita en la solicitud POST o PUT de un grupo, se ignora la edición.
|
nonEditableAliases[] |
string
Solo lectura. Es la lista de las direcciones de correo electrónico de alias no editables del grupo que están fuera del dominio principal o los subdominios de la cuenta. Estas son direcciones de correo electrónico funcionales que usa el grupo. Esta es una propiedad de solo lectura que se muestra en la respuesta de la API para un grupo. Si se edita en la solicitud POST o PUT de un grupo, se ignora la edición.
|
Métodos |
|
Borra un grupo. |
|
Recupera las propiedades de un grupo. |
|
Crea un grupo. |
|
Recupera todos los grupos de un dominio o de un usuario a partir de una userKey (paginada). |
|
Actualiza las propiedades de un grupo. |
|
Actualiza las propiedades de un grupo. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-24 (UTC)
[null,null,["Última actualización: 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. |"]]