Method: members.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Solicitud HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros |
groupKey |
string
Identifica el grupo en la solicitud a la API. El valor puede ser la dirección de correo electrónico, el alias o el ID único del grupo.
|
Parámetros de consulta
Parámetros |
includeDerivedMembership |
boolean
Indica si se deben enumerar las membresías indirectas. Valor predeterminado: false.
|
maxResults |
integer
Cantidad máxima de resultados que se mostrarán. El valor máximo permitido es 200.
|
pageToken |
string
Es un token para especificar la página siguiente de la lista.
|
roles |
string
El parámetro de consulta roles te permite recuperar miembros del grupo por rol. Los valores permitidos son OWNER , MANAGER y MEMBER .
|
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,
"members": [
{
object (Member )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
Indica el tipo de recurso.
|
etag |
string
ETag del recurso.
|
members[] |
object (Member )
Una lista de objetos de miembro.
|
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.member
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.group.readonly
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],[],null,["# Method: members.list\n\nRetrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `groupKey` | `string` Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `includeDerivedMembership` | `boolean` Whether to list indirect memberships. Default: false. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `pageToken` | `string` Token to specify next page in the list. |\n| `roles` | `string` The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"members\": [ { object (/workspace/admin/directory/reference/rest/v1/members#Member) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `members[]` | `object (`[Member](/workspace/admin/directory/reference/rest/v1/members#Member)`)` A list of member objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]