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 |
El ID único de la cuenta de Google Workspace del cliente. En el caso de una cuenta de varios dominios, usa este campo en lugar de |
domain |
Es el nombre de dominio. Usa este campo para obtener grupos de un solo dominio. Para mostrar todos los dominios de la cuenta de un cliente, usa el parámetro de búsqueda |
maxResults |
Cantidad máxima de resultados que se mostrarán El valor máximo permitido es 200. |
orderBy |
Columna para ordenar los resultados |
pageToken |
Token para especificar la página siguiente de la lista |
query |
Búsqueda de cadenas de consulta. Debe tener el formato “ |
sortOrder |
Indica si se deben mostrar los resultados en orden ascendente o descendente. Solo se usa cuando también se usa orderBy. |
userKey |
Es el correo electrónico o el ID inmutable del usuario si solo se deben enumerar esos grupos, si el usuario determinado es miembro. Si es un ID, debe coincidir con el ID del objeto del usuario. |
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 ( |
Campos | |
---|---|
kind |
Este es el tipo de recurso. |
etag |
ETag del recurso. |
groups[] |
Una lista de objetos de grupo. |
nextPageToken |
El token se usa para acceder a la página siguiente de este resultado. |
Permisos de autorización
Se necesita uno de los siguientes alcances 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
Enumeradores | |
---|---|
EMAIL |
Es el correo electrónico del grupo. |
SortOrder
Enumeradores | |
---|---|
ASCENDING |
Orden ascendente. |
DESCENDING |
Orden descendente. |