API Directory: participantes do grupo

Adicionar um participante a um grupo

Para adicionar um participante 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 participante 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 grupo, poderá haver um atraso de até 10 minutos até 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 membro do grupo2, o grupo2 não poderá fazer parte 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 participante é liz@example.com, e o papel 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"
}

A role de um participante do grupo pode ser:

  • OWNER: este papel pode alterar o envio de mensagens para o grupo, adicionar ou remover participantes, alterar as funções dos participantes, alterar as configurações do grupo e excluir o grupo. Um OWNER precisa ser participante do grupo.
  • MANAGER: essa função só está disponível se o Google Workspace for ativado no Admin Console. A função ADMINISTRADOR pode realizar todas as ações da função PROPRIETÁRIO, exceto tornar um participante 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ões e visualizar a lista de membros do grupo. Para mais informações sobre funções de membros, consulte a Central de Ajuda para administração.

Resposta JSON

Uma resposta bem-sucedida retornará um código de status HTTP 200 e as informações de associação do membro. O id é o ID de assinatura exclusivo do membro: 

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

A type de um participante do grupo 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 do grupo ou o id exclusivo do grupo, e memberKey é o endereço de e-mail principal do usuário ou do grupo, o endereço de e-mail do 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 o papel dele no grupo é alterado de MEMBER para MANAGER. O groupKey da solicitação PUT neste exemplo é NNNNN. Para informações sobre as funções MEMBER, OWNER e MANAGER, consulte a Central de Ajuda para 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 retornará um código de status HTTP 200 e as informações de associação atualizadas. O id é o ID de assinatura exclusivo 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 do grupo ou o id exclusivo do grupo, e memberKey é o endereço de e-mail principal do usuário ou do grupo, o endereço de e-mail do 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 retornará um código de status HTTP 200 e as informações de associação do membro. O id é o ID de assinatura exclusivo 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 do grupo 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 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 dos membros. 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 de resposta. Sua próxima solicitação usa esse token como o valor de string de consulta pageToken.

Resposta JSON

Uma resposta bem-sucedida retornará um código de status HTTP 200 e a lista de informações do membro. O id é o ID de assinatura exclusivo do membro. Há uma nextPageToken para a lista seguinte 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 em um grupo

Para excluir a associação de um participante 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 participante 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 com groupKey nnn e memberKey como 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

Se a resposta for bem-sucedida, o código de status HTTP 200 será retornado.

Veja o que acontece quando um membro é excluído:

  • Os membros que você remover não receberão 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, o grupo ainda funcionará normalmente. Como administrador, você pode gerenciar o grupo ou atribuir a propriedade a outro membro