Method: members.list

Recupera uma lista paginada de todos os membros de um grupo. Esse método expira após 60 minutos. Saiba mais em Resolver problemas com códigos de erro.

Solicitação HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

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

Parâmetros de caminho

Parâmetros
groupKey

string

Identifica o grupo na solicitação da API. O valor pode ser o endereço de e-mail do grupo, o alias do grupo ou o ID exclusivo do grupo.

Parâmetros de consulta

Parâmetros
includeDerivedMembership

boolean

Indica se as associações indiretas serão listadas. (Padrão: falso).
maxResults

integer

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

string

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

string

O parâmetro de consulta roles permite que você recupere membros do grupo por função. Os valores permitidos são OWNER, MANAGER e MEMBER.

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,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Tipo de recurso em questão.
etag

string

ETag do recurso.
members[]

object (Member)

Uma lista de objetos de membro.
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.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

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