Gerenciar grupos

Esta página explica como gerenciar Grupos do Google com a API Directory:

  • Criar um grupo
  • Atualizar um grupo
  • Adicionar um alias de grupo
  • Recuperar um grupo
  • Recuperar todos os grupos de um domínio ou da conta
  • Recuperar todos os grupos de um membro
  • Recuperar todos os aliases de grupo
  • Excluir um alias de grupo
  • Excluir um grupo

Criar um grupo

Para criar um grupo, use a seguinte solicitação POST e inclua a autorização descritos em Autorizar solicitações Você pode criar um grupo para qualquer domínio associado à conta. Para as strings de consulta, request, e propriedades de resposta, consulte a método groups.insert. 

POST https://admin.googleapis.com/admin/directory/v1/groups

A solicitação JSON a seguir mostra um exemplo de corpo de solicitação que cria um grupo. E-mail do grupo O endereço é sales_group@example.com: 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Uma resposta bem sucedida retorna um Código de status HTTP 201 e as propriedades do novo grupo.

Atualizar um grupo

Para atualizar as configurações de um grupo, use a seguinte solicitação PUT e inclua o autorização descrita em Autorizar solicitações O groupKey é o endereço de e-mail do grupo, qualquer um dos endereços de e-mail do alias do grupo. ou o id exclusivo do grupo. Para as strings de consulta, as propriedades de solicitação e de resposta, consulte método groups.update. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Em geral, o Google recomenda não usar o endereço de e-mail do grupo como chave para dados persistentes. porque o endereço de e-mail está sujeito a alterações.

No exemplo a seguir, o groupKey exclusivo é nnn, e o valor nome é APAC Sales Group: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

Para um pedido de atualização, você só precisa enviar as informações atualizadas. Você não precisa inserir todas as propriedades do grupo na solicitação.

Uma resposta bem sucedida retorna um Código de status HTTP 201 e as propriedades do novo grupo: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Adicionar um alias de grupo

Para adicionar um alias de grupo, use a seguinte solicitação do POST e inclua a autorização descritos em Autorizar solicitações. O groupKey é o endereço de e-mail do grupo, qualquer um dos aliases do grupo. endereço de e-mail ou o id exclusivo do grupo. Para obter as strings de consulta, as propriedades de solicitação e de resposta, consulte o recurso groups. 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Em geral, o Google recomenda não usar o endereço de e-mail do grupo como chave para dados persistentes. porque o endereço de e-mail está sujeito a alterações.

A solicitação JSON a seguir mostra um exemplo de solicitação para criar o alias de um grupo. A groupKey é o id exclusivo do grupo representado por NNNN.

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Uma resposta bem sucedida retorna um Código de status HTTP 201 e as propriedades do novo alias de grupo.

Recuperar um grupo

Para recuperar um grupo, use a seguinte solicitação GET e inclua a autorização descritos em Autorizar solicitações O groupKey é o endereço de e-mail do grupo, qualquer um dos aliases do grupo. endereço de e-mail ou o id exclusivo do grupo. Para obter as strings de consulta, as propriedades de solicitação e de resposta, consulte o método groups.get. 
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Em geral, o Google recomenda não usar o endereço de e-mail do grupo como chave para dados persistentes. porque o endereço de e-mail está sujeito a alterações.

No exemplo a seguir, o ID groupKey exclusivo é nnnn: 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Uma resposta bem sucedida retorna um Código de status HTTP 200 e as configurações do grupo: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Recuperar todos os grupos de um domínio ou da conta

Para recuperar todos os grupos de um domínio específico ou da conta, use o seguinte GET solicitação e incluir a autorização descrita em Autorizar solicitações Para a consulta strings, solicitação e propriedades de resposta, consulte a método groups.list. Para facilitar a leitura, este exemplo usa retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Ao recuperar todos os grupos de um domínio ou da conta, considere o seguinte:

  • Todos os grupos de um subdomínio: use o argumento domain com o nome do domínio.
  • Todos os grupos da conta: use o argumento customer com uma my_customer ou o valor customerId da conta. Como uma conta administrador, use a string my_customer para representar o customerId. Se você for um revendedor com acesso à conta de um cliente de revenda, use o customerId da conta de revenda. Para o valor customerId, use o nome de domínio principal da conta no Recuperar todos os usuários em um domínio solicitação da operação. A resposta resultante tem o valor customerId.
  • Usando os argumentos domain e customer: o A API Directory retorna todos os grupos para domain.
  • Não usando os argumentos domain e customer: o A API Directory retorna todos os grupos da conta associada a my_customer Esta é a conta customerId do administrador que está fazendo da solicitação.
  • Usando os argumentos customer e userKey: o A API Directory retorna um erro. É necessário fazer duas solicitações separadas com essas .

No exemplo a seguir, um administrador de conta usa my_customer para solicitar uma lista de todos os grupos de uma conta:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

No exemplo a seguir, a solicitação do administrador de um revendedor retorna todos os grupos da conta de revenda com o método customerId C03az79cb. O máximo de resultados retornados por página de resposta é 2. Há um nextPageToken para a lista de usuários na resposta: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Uma resposta bem sucedida retorna um Código de status HTTP 200 e os grupos na ordem alfabética do e-mail do grupo: 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Recuperar todos os grupos de um membro

Para recuperar todos os grupos em que um participante tem uma assinatura, use o seguinte GET solicitação e incluir a autorização descrita em Autorizar solicitações Para facilitar a leitura, este exemplo usa retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page
  • Um participante pode ser um usuário ou um grupo.
  • O userKey pode ser o endereço de e-mail principal, o endereço de e-mail do alias do usuário o endereço de e-mail principal de um grupo, o alias de e-mail do grupo ou o id exclusivo do usuário que podem ser encontrados usando o Recuperar uma operação do usuário.
  • O usuário ou grupo especificado em userKey precisa pertencer ao seu domínio.
  • Use a string de consulta pageToken para respostas com um grande número de grupos. Na caso de paginação, a resposta retornará a propriedade nextPageToken, que fornece um token para a próxima página de resultados de resposta. Sua próxima solicitação usará esse token como o Valor da string de consulta pageToken.
  • Usando os argumentos customer e userKey: o A API Directory retorna um erro. É necessário fazer duas solicitações separadas com essas .

Para obter as propriedades de solicitação e resposta, consulte a método groups.list.

Uma resposta bem sucedida retorna um Código de status HTTP 200 e a lista de informações de membros:

  • Todos os grupos nos quais um membro se inscreveu, incluindo grupos de fora da rede domínio, serão retornadas.
  • Os grupos são retornados na ordem alfabética do endereço de e-mail de cada grupo.
  • No corpo da resposta, id é o ID exclusivo do grupo.
  • Na resposta, a listagem de um grupo de fora do domínio do usuário não inclui o fora dos aliases do grupo. 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Recuperar todos os aliases de grupo

Para recuperar todos os aliases de um grupo, use a seguinte solicitação GET e inclua o autorização descrita em Autorizar solicitações A groupKey pode ser o endereço de e-mail principal, o endereço de e-mail exclusivo do grupo id ou qualquer um dos aliases de grupo e-mails. Para obter as propriedades de solicitação e resposta, consulte o recurso groups. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Uma resposta bem sucedida retorna um Código de status HTTP 201 e uma lista dos aliases do grupo.

Excluir um alias de grupo

Para excluir o alias de um grupo, use a seguinte solicitação DELETE e inclua o autorização descrita em Autorizar solicitações O groupKey pode ser o endereço de e-mail principal, o endereço de e-mail id ou de qualquer um dos aliases de grupo e-mails. O aliasId é o alias excluída. Para as propriedades de solicitação e resposta, consulte o recurso groups: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Uma resposta bem sucedida retorna um Código de status HTTP 201.

Excluir um grupo

Para excluir um grupo, use a seguinte solicitação DELETE e inclua a autorização descritos em Autorizar solicitações O groupKey é o id exclusivo do grupo: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
 Por exemplo, esta solicitação DELETE exclui o grupo que tem o grupo nnnn id: 
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Uma resposta bem sucedida retorna um Código de status HTTP 200.

Quando um grupo é excluído, acontece o seguinte:

  • Todos os participantes do grupo serão excluídos. As contas de usuário do participante não são excluídas.
  • O arquivo do grupo foi excluído.
  • As mensagens enviadas para o endereço do grupo excluído não são entregues. Em vez disso, o remetente recebe uma mensagem de erro na entrega.