Method: groups.list

Recupera todos os grupos de um domínio ou de um usuário usando uma userKey (paginada).

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
customer

string

O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta de vários domínios, use este campo em vez de domain para buscar todos os grupos de um cliente. Você também pode usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso Users. É necessário fornecer o parâmetro customer ou domain.
domain

string

O nome do domínio. Use este campo para receber grupos de apenas um domínio. Para retornar todos os domínios de uma conta de cliente, use o parâmetro de consulta customer.
maxResults

integer

Número máximo de resultados a serem retornados. O valor máximo permitido é 200.
orderBy

enum (OrderBy)

Coluna a ser usada para classificar os resultados
pageToken

string

Token para especificar a próxima página na lista.
query

string

Pesquisa de string de consulta. Contém uma ou mais cláusulas de pesquisa, cada uma com um campo, um operador e um valor. Para conferir a documentação completa, acesse Pesquisar grupos.
sortOrder

enum (SortOrder)

Se os resultados serão retornados em ordem crescente ou decrescente. Só é útil quando "orderBy" também é usado
userKey

string

E-mail ou ID imutável do usuário se apenas esses grupos forem listados, o usuário especificado for membro. Se for um ID, ele precisa corresponder ao ID do objeto do usuário. Não pode ser usado com o parâmetro customer.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Tipo de recurso.
etag

string

ETag do recurso.
groups[]

object (Group)

Uma lista de objetos de grupo.
nextPageToken

string

Token usado para acessar a próxima página deste resultado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

Para mais informações, consulte o guia de autorização.

OrderBy

Tipos enumerados
EMAIL E-mail do grupo.

SortOrder

Tipos enumerados
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.