API Directory: membros do grupo
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Adicionar um participante a um grupo
Para adicionar um membro a um grupo, use a solicitação POST abaixo e inclua a autorização descrita em Autorizar solicitações. Um membro do grupo pode ser um usuário ou outro grupo. O groupKey é o endereço de e-mail do grupo do novo membro ou o id exclusivo do grupo. Para as propriedades de solicitação e resposta, consulte a Referência da API:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Se você adicionar um grupo como membro de outro, pode haver um atraso de até 10 minutos até que os participantes do grupo filho apareçam como membros do grupo pai. Além disso, a API retorna um erro para ciclos em associações de grupo. Por exemplo, se o grupo1 for membro do grupo2, o grupo2 não poderá ser membro do grupo1.
Solicitação JSON
A solicitação JSON a seguir mostra um exemplo de corpo de solicitação que cria um membro do grupo. O endereço de e-mail do membro é liz@example.com, e a função dele no grupo é MEMBER. A solicitação POST usa NNNNN para o groupKey:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
O role de um membro do grupo pode ser:
OWNER: essa função pode enviar mensagens para o grupo, adicionar ou remover participantes, mudar as funções dos participantes, alterar as configurações do grupo e excluir o grupo. Um OWNER precisa ser membro do grupo.
MANAGER: essa função só está disponível se o Google Workspace estiver ativado pelo Admin Console. Uma função de GERENTE pode fazer tudo o que uma função de PROPRIETÁRIO, exceto transformar um membro em PROPRIETÁRIO ou excluir o grupo. Um grupo pode ter vários membros com a função de PROPRIETÁRIO e GERENTE.
MEMBER: essa função pode se inscrever em um grupo, acessar os arquivos de discussão e a lista de participantes do grupo. Para mais informações sobre os papéis de membro, consulte a Central de Ajuda para administradores.
Resposta JSON
Uma resposta bem-sucedida retorna um código de status HTTP 200 e as informações de associação do membro. O id é o ID exclusivo de associação do membro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
O type de um membro do grupo pode ser:
GROUP: o participante é outro grupo.MEMBER: o participante é um usuário
Atualizar a participação em um grupo
Para atualizar a associação a um grupo, use a seguinte solicitação PUT e inclua a autorização descrita em Autorizar solicitações. O groupKey é o endereço de e-mail do grupo ou o id exclusivo do grupo, e o memberKey é o endereço de e-mail principal do usuário ou do grupo, um endereço de e-mail de alias do usuário ou o id exclusivo do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Solicitação JSON
A solicitação JSON a seguir mostra um exemplo de corpo de solicitação que atualiza as configurações de associação a um grupo. O endereço de e-mail do participante é liz@example.com, e a função dele no grupo foi alterada de MEMBER para MANAGER. O groupKey da solicitação PUT neste exemplo é NNNNN. Para saber mais sobre as funções MEMBER, OWNER e MANAGER, consulte a Central de Ajuda de administração:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
Resposta JSON
Uma resposta bem-sucedida retorna um código de status HTTP 200 e as informações de associação atualizadas. O id é o ID exclusivo de associação do membro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Extrair um participante de um grupo
Para recuperar uma associação a um grupo, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. O groupKey é o endereço de e-mail do grupo ou o id exclusivo do grupo, e o memberKey é o endereço de e-mail principal do usuário ou do grupo, um endereço de e-mail de alias do usuário ou o id exclusivo do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Resposta JSON
Uma resposta bem-sucedida retorna um código de status HTTP 200 e as informações de associação do membro. O id é o ID exclusivo de associação do membro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Extrair todos os membros do grupo
Para recuperar todos os membros do grupo, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. O groupKey é o endereço de e-mail do grupo ou o id exclusivo do grupo. A string de consulta roles opcional é um filtro que permite recuperar membros do grupo por função, e as coleções de função resultantes estão na ordem especificada no filtro roles. Para as propriedades de solicitação e resposta, consulte a Referência da API. Para facilitar a leitura, este exemplo usa retornos de linha:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
Todos os membros são retornados na ordem alfabética dos endereços de e-mail. E use a string de consulta pageToken para respostas com um grande número de membros. No caso da paginação, a resposta retorna a propriedade nextPageToken, que tem um token para a próxima página de resultados. A próxima solicitação usa esse token como o valor da string de consulta pageToken.
Resposta JSON
Uma resposta bem-sucedida retorna um código de status HTTP 200 e a lista de informações do membro. O id é o ID exclusivo de associação do membro. Há um nextPageToken para a lista de acompanhamento dos membros do grupo nesta resposta:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
}
Excluir a participação em um grupo
Para excluir a associação de um membro a um grupo, use a solicitação DELETE abaixo e inclua a autorização descrita em Autorizar solicitações. O groupKey é o id exclusivo do grupo, e memberKey é o endereço de e-mail principal do usuário ou membro do grupo excluído ou o id exclusivo do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API.
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Por exemplo, esta solicitação DELETE exclui o membro cujo groupKey é nnn e cujo memberKey é o endereço de e-mail principal do usuário, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Uma resposta bem-sucedida retorna um código de status HTTP 200.
Quando um membro é excluído:
- Os participantes removidos não vão mais receber e-mails endereçados ao grupo.
- A remoção de um participante de um grupo não exclui a conta do usuário.
- Se você excluir o proprietário, o grupo continuará funcionando normalmente. Como administrador, você pode gerenciar o grupo ou atribuir a propriedade a outro participante
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-08-29 UTC.
[null,null,["Última atualização 2025-08-29 UTC."],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
