API de Directory: Miembros del grupo
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Cómo agregar un miembro a un grupo
Para agregar un miembro a un grupo, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Autorizar solicitudes. Un miembro de un grupo puede ser un usuario o otro grupo. groupKey es la dirección de correo electrónico del grupo del miembro nuevo o el id único del grupo. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Si agregas un grupo como miembro de otro, es posible que haya una demora de hasta 10 minutos antes de que los miembros del grupo secundario aparezcan como miembros del grupo superior. Además, la API muestra un error para los ciclos en las membresías de grupo. Por ejemplo, si el grupo1 es miembro del grupo2, el grupo2 no puede ser miembro del grupo1.
Solicitud JSON
En la siguiente solicitud JSON, se muestra un cuerpo de solicitud de muestra que crea un miembro de grupo. La dirección de correo electrónico del miembro es liz@example.com y su rol en el grupo es MEMBER. La solicitud POST usa NNNNN para el groupKey:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
El role de un miembro del grupo puede ser lo siguiente:
OWNER: Con este rol, se pueden enviar mensajes al grupo, agregar o quitar miembros, cambiar sus roles, modificar la configuración del grupo y borrarlo. Un OWNER debe ser miembro del grupo.
MANAGER: Este rol solo está disponible si Google Workspace está habilitado en la Consola del administrador. Un rol de ADMINISTRADOR puede hacer todo lo que hace un rol de PROPIETARIO, excepto designar a un miembro como PROPIETARIO o borrar el grupo. Un grupo puede tener varios miembros con el rol de PROPIETARIO y ADMINISTRADOR.
MEMBER: Los usuarios con este rol pueden suscribirse a un grupo, ver los archivos de conversaciones y ver la lista de membresías del grupo. Para obtener más información sobre los roles de los miembros, consulta el Centro de ayuda de administración.
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200 y la información de membresía del miembro. id es el ID de membresía único del miembro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
El type de un miembro del grupo puede ser lo siguiente:
GROUP: El miembro es otro grupo.MEMBER: El miembro es un usuario.
Actualiza la membresía de un grupo
Para actualizar la membresía de un grupo, usa la siguiente solicitud PUT y, luego, incluye la autorización que se describe en Autorizar solicitudes. groupKey es la dirección de correo electrónico del grupo o el id único del grupo, y memberKey es la dirección de correo electrónico principal del usuario o del grupo, la dirección de correo electrónico de alias del usuario o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Solicitud JSON
En la siguiente solicitud JSON, se muestra un cuerpo de solicitud de muestra que actualiza la configuración de membresía de un grupo. La dirección de correo electrónico del miembro es liz@example.com y su rol en el grupo cambia de MEMBER a MANAGER. El groupKey de la solicitud PUT en este ejemplo es NNNNN. Para obtener información sobre los roles de MIEMBRO, PROPIETARIO y ADMINISTRADOR, consulta el Centro de ayuda de administración:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200 y la información de membresía actualizada. id es el ID de membresía único del miembro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Cómo recuperar el miembro de un grupo
Para recuperar la membresía de un grupo, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. groupKey es la dirección de correo electrónico del grupo o el id único del grupo, y memberKey es la dirección de correo electrónico principal del usuario o del grupo, la dirección de correo electrónico de alias del usuario o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200 y la información de membresía del miembro. id es el ID de membresía único del miembro:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Cómo recuperar todos los miembros del grupo
Para recuperar a todos los miembros del grupo, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. groupKey es la dirección de correo electrónico del grupo o el id único del grupo. La cadena de consulta roles opcional es un filtro que te permite recuperar miembros de grupos por rol, y las colecciones de roles resultantes están en el orden que se indica en el filtro roles. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API. Para facilitar la lectura, este ejemplo usa saltos de línea:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
Todos los miembros se muestran en orden alfabético según sus direcciones de correo electrónico. Además, usa la cadena de consulta pageToken para las respuestas con una gran cantidad de miembros. En el caso de la paginación, la respuesta muestra la propiedad nextPageToken, que tiene un token para la siguiente página de resultados de la respuesta. Tu próxima solicitud usará este token como el valor de la cadena de consulta pageToken.
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200 y la lista de información del miembro. id es el ID de membresía único del miembro. Hay un nextPageToken para la lista de seguimiento de los miembros del grupo en esta respuesta:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
}
Cómo borrar la membresía de un grupo
Para borrar la membresía de un miembro en un grupo, usa la siguiente solicitud DELETE y, luego, incluye la autorización que se describe en Autorizar solicitudes. groupKey es el id único del grupo y memberKey es la dirección de correo electrónico principal del usuario o miembro del grupo eliminado, o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Por ejemplo, esta solicitud DELETE borra el miembro cuyo groupKey es nnn y cuyo memberKey es la dirección de correo electrónico principal del usuario, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Una respuesta correcta muestra un código de estado HTTP 200.
Cuando se borra un miembro, ocurre lo siguiente:
- Los miembros que quites ya no recibirán correos electrónicos dirigidos al grupo.
- Si quitas a un miembro de un grupo, no se borrará la cuenta del usuario.
- Si borras al propietario del grupo, este seguirá funcionando con normalidad. Como administrador, puedes administrar el grupo o asignar la propiedad a otro miembro.
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-08-29 (UTC)
[null,null,["Última actualización: 2025-08-29 (UTC)"],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
