Method: groups.list

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Recupera todos os grupos de um domínio ou de um usuário com 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, para buscar todos os grupos de um cliente, use este campo em vez de domain. Você também pode usar o alias my_customer para representar os customerId da sua conta. O customerId também é retornado como parte do recurso Users. Forneça o parâmetro customer ou domain.

domain

string

O nome do domínio. Use este campo para ver 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 para usar na classificação dos resultados

pageToken

string

Token para especificar a próxima página da lista

query

string

Pesquisa da string de consulta. Deve estar no formato "". A documentação completa está em https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups

sortOrder

enum (SortOrder)

Indica se os resultados serão retornados em ordem crescente ou decrescente. Usado somente quando orderBy também é usado

userKey

string

E-mail ou ID imutável do usuário se apenas os grupos forem listados, de que o usuário é membro. Se for um ID, ele deve corresponder ao ID do objeto do usuário.

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

Que tipo de recurso é esse.

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 desse resultado.

Escopos de autorização

Requer um dos seguintes escopos de 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 a Visão geral do OAuth 2.0.

OrderBy

Enums
EMAIL E-mail do grupo.

SortOrder

Enums
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.