API Directory: membros do grupo

Adicionar um participante a um grupo

Para adicionar um membro a um grupo, use a seguinte solicitação POST 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 participante de outro, pode levar até 10 minutos para que os participantes do grupo filho apareçam como participantes do grupo pai. Além disso, a API retorna um erro para ciclos em associações a grupos. Por exemplo, se o grupo1 for um participante do grupo2, o grupo2 não poderá ser um participante 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 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 mudar o envio de 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 usando o Google Admin Console. A função de ADMINISTRADOR pode fazer tudo o que a função de PROPRIETÁRIO faz, exceto transformar um membro em PROPRIETÁRIO ou excluir o grupo. Um grupo pode ter vários membros com as funções de PROPRIETÁRIO e GERENTE.
  • MEMBER: essa função permite se inscrever em um grupo, ver 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 da 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 membro é um usuário.

Atualizar uma associação a um grupo

Para atualizar uma 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 dele, e o memberKey é o endereço de e-mail principal do usuário ou do grupo, o endereço de e-mail de alias de um 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 mudou de MEMBER para MANAGER. O groupKey da solicitação PUT neste exemplo é NNNNN. Para informações sobre as funções de MEMBRO, PROPRIETÁRIO e GERENTE, 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 atualizadas da assinatura. O id é o ID exclusivo da associação do membro: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Recuperar um membro 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 dele, e o memberKey é o endereço de e-mail principal do usuário ou do grupo, o endereço de e-mail de alias de um 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 da associação do membro: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Recuperar 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 ou o id exclusivo do grupo. A string de consulta roles opcional é um filtro que permite recuperar membros do grupo por função. As coleções de funções 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 em ordem alfabética dos endereços de e-mail. 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. Sua 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 dos membros. O id é o ID exclusivo da associação do membro. Há um nextPageToken para a lista de participantes 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 seguinte solicitação DELETE e inclua a autorização descrita em Autorizar solicitações. O groupKey é o id exclusivo do grupo, e o 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 vai continuar funcionando normalmente. Como administrador, você pode gerenciar o grupo ou atribuir a propriedade a outro participante.