REST Resource: groups
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: grupo
Com os Grupos do Google, os usuários podem enviar mensagens para grupos de pessoas usando o endereço de e-mail do grupo. Para mais informações sobre tarefas comuns, consulte o Guia para desenvolvedores.
Para saber mais sobre outros tipos de grupos, consulte a documentação da API Cloud Identity Groups.
Observação: o usuário que chama a API (ou que está sendo falsificado por uma conta de serviço) precisa ter um papel atribuído que inclua permissões de grupos da API Admin, como superadministrador ou administrador de grupos.
| Representação JSON |
{
"id": string,
"email": string,
"name": string,
"description": string,
"adminCreated": boolean,
"directMembersCount": string,
"kind": string,
"etag": string,
"aliases": [
string
],
"nonEditableAliases": [
string
]
} |
| Campos |
id |
string
Somente leitura. O ID exclusivo de um grupo. Um id de grupo pode ser usado como groupKey de um URI de solicitação de grupo.
|
email |
string
O endereço de e-mail do grupo. Se a sua conta tiver vários domínios, selecione o domínio apropriado para o endereço de e-mail. O email precisa ser único. Essa propriedade é obrigatória ao criar um grupo. Os endereços de e-mail de grupo estão sujeitos às mesmas regras de uso de caracteres que os nomes de usuário. Consulte a Central de Ajuda para mais detalhes.
|
name |
string
O nome de exibição do grupo.
|
description |
string
Uma descrição detalhada para ajudar os usuários a determinar o propósito de um grupo. Por exemplo, você pode incluir informações sobre quem pode participar, os tipos de mensagens que você enviará, links para perguntas frequentes sobre o grupo ou grupos relacionados. O nome deve ter no máximo 4,096 caracteres.
|
adminCreated |
boolean
Somente leitura. O valor é true se o grupo foi criado por um administrador em vez de um usuário.
|
directMembersCount |
string (int64 format)
O número de usuários que são membros diretos do grupo. Se um grupo for um participante (filho) desse grupo (o pai), os participantes do grupo filho não serão contados na propriedade directMembersCount do grupo pai.
|
kind |
string
O tipo do recurso da API. Para recursos de grupos, o valor é admin#directory#group.
|
etag |
string
ETag do recurso.
|
aliases[] |
string
Somente leitura. A lista de endereços de e-mail de alias de um grupo. Para adicionar, atualizar ou remover os aliases de um grupo, use os métodos groups.aliases. Se forem editadas na solicitação POST ou PUT de um grupo, as edições serão ignoradas.
|
nonEditableAliases[] |
string
Somente leitura. A lista de endereços de e-mail de alias não editáveis do grupo que estão fora do domínio ou dos subdomínios principais da conta. São endereços de e-mail válidos usados pelo grupo. Essa é uma propriedade somente leitura retornada na resposta da API para um grupo. Se forem editadas na solicitação POST ou PUT de um grupo, as edições serão ignoradas.
|
Métodos |
|
|
Exclui um grupo. |
|
|
Recupera as propriedades de um grupo. |
|
|
Cria um grupo. |
|
|
Recupera todos os grupos de um domínio ou de um usuário com uma userKey (paginado). |
|
|
Atualiza as propriedades de um grupo. |
|
|
Atualiza as propriedades de um grupo. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-24 UTC.
[null,null,["Última atualização 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. |"]]
