Method: groups.list

Recupera todos los grupos de un dominio o de un usuario determinado por medio de una userKey (paginado).

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

Es 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. El customerId también se devuelve como parte del recurso Users. Debes proporcionar el parámetro customer o el domain.
domain

string

Es el nombre de dominio. Usa este campo para obtener grupos de un solo dominio. Para devolver todos los dominios de una cuenta de cliente, usa el parámetro de consulta customer.
maxResults

integer

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

enum (OrderBy)

Columna que se usará para ordenar los resultados
pageToken

string

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

string

Búsqueda de cadenas de consulta. Contiene una o más cláusulas de búsqueda, cada una con un campo, un operador y un valor. Para obtener la documentación completa, consulta Cómo buscar grupos.
sortOrder

enum (SortOrder)

Indica si se devuelven resultados en orden ascendente o descendente. Solo es útil cuando también se usa orderBy.
userKey

string

Es el ID inmutable o el correo electrónico del usuario del que el usuario determinado es miembro, si solo se deben enumerar esos grupos. Si es un ID, debe coincidir con el ID del objeto del usuario. No se puede usar 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

Tipo de recurso.
etag

string

ETag del recurso.
groups[]

object (Group)

Es una lista de objetos de grupo.
nextPageToken

string

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

Permisos 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