API Directory: membros do grupo

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