Method: groups.list

Recupera todos los grupos de un dominio o de un usuario a partir de una userKey (paginada).

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
customer

string

El ID único de la cuenta de Google Workspace del cliente. En el caso de una cuenta de varios dominios, para recuperar todos los grupos de un cliente, usa este campo en lugar de domain. También puedes usar el alias my_customer para representar el customerId de tu cuenta. customerId también se muestra como parte del recurso Users. Debes proporcionar el parámetro customer o domain.
domain

string

El nombre de dominio. Usa este campo para obtener grupos de un solo dominio. Para mostrar todos los dominios de una cuenta de cliente, usa el parámetro de búsqueda customer en su lugar.
maxResults

integer

Cantidad máxima de resultados que se mostrarán. El valor máximo permitido es 200.
orderBy

enum (OrderBy)

Columna que se usa para ordenar los resultados
pageToken

string

Token para especificar la página siguiente en la lista
query

string

Búsqueda de cadenas de consulta Debe tener el formato "". La documentación completa se encuentra en https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Si se devuelven resultados en orden ascendente o descendente. Solo se usa cuando también se usa orderBy.
userKey

string

El correo electrónico o el ID inmutable del usuario, si solo se deben enumerar esos grupos, el usuario determinado es miembro. Si es un ID, debe coincidir con el ID del objeto de usuario. No se puede utilizar con el parámetro customer.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Indica el tipo de recurso.
etag

string

ETag del recurso.
groups[]

object (Group)

Una lista de objetos de grupo.
nextPageToken

string

Es el token que se usa para acceder a la siguiente página de este resultado.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 obtener más información, consulta la Guía de autorización.

OrderBy

Enumeraciones
EMAIL Es el correo electrónico del grupo.

SortOrder

Enumeraciones
ASCENDING Orden ascendente.
DESCENDING Orden descendente.