API Directory: participantes do grupo

Adicionar um membro 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 participante pode ser um usuário ou outro grupo. O groupKey é o endereço de e-mail do grupo do novo participante ou o id exclusivo do grupo. Para obter 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 grupo, poderá haver um atraso de até 10 minutos antes que os participantes do grupo filho apareçam como membros do grupo pai. Além disso, a API retorna um erro para ciclos de associações a grupos. Por exemplo, se group1 for membro de grupo2, grupo2 não pode ser membro de 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 participante é 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 participante pode ser:

  • OWNER: esta função pode alterar o envio de mensagens para o grupo, adicionar ou remover membros, alterar as funções dos membros, alterar as configurações do grupo e excluir o grupo. O OWNER precisa ser participante do grupo.
  • MANAGER: esse papel só estará disponível se o Google Workspace for ativado usando o Admin Console. Uma função de ADMINISTRADOR pode realizar todas as ações realizadas por uma função PROPRIETÁRIO, exceto tornar um participante um PROPRIETÁRIO ou excluir o grupo. Um grupo pode ter vários membros OWNER e MANAGER.
  • MEMBER – Este papel pode se inscrever em um grupo, visualizar arquivos de discussão e visualizar a lista de membros do grupo. Para mais informações sobre as funções de membros, consulte a Central de Ajuda de administração.

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 participante pode ser:

  • GROUP – O membro é outro grupo.
  • MEMBER – O membro é um usuário.

Atualizar a associação a 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 ou o id exclusivo do grupo, e o memberKey é o endereço de e-mail principal, o endereço de e-mail do alias ou o id exclusivo do usuário ou do grupo. Para obter 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 do participante no grupo é alterada de MEMBER para MANAGER. O groupKey da solicitação PUT neste exemplo é NNNNN. Para saber mais sobre os papéis 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 da associação do membro: 

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

Recuperar o 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 ou o id exclusivo do grupo, e o memberKey é o endereço de e-mail principal, o endereço de e-mail do alias ou o id exclusivo do usuário ou do grupo. Para obter 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 participantes 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 papel. As coleções de papéis resultantes estão na ordem informada no filtro roles. Para obter 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 nomes endereços de e-mail. E use a string de consulta pageToken para respostas com um grande número de membros. No caso de paginação, a resposta retorna a propriedade nextPageToken, que tem um token para a próxima página de resultados da resposta. Sua próxima solicitação vai usar 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 da associação do membro. Há uma 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": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "nextPageToken": "NNNNN"
}

Excluir a associação a 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 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 obter 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 participante é excluído:

  • Os membros removidos não recebem mais e-mails endereçados ao grupo.
  • A remoção de um membro de um grupo não exclui a conta do usuário.
  • Se você excluir o proprietário do grupo, o grupo continuará funcionando normalmente. Como administrador, você pode gerenciar o grupo ou atribuir a propriedade a outro membro