API de Directory: Miembros de grupo

Agrega un miembro a un grupo

Para agregar un miembro a un grupo, usa la siguiente solicitud POST e incluye la autorización que se describe en Autoriza solicitudes. Un miembro del grupo puede ser un usuario o algún otro grupo. groupKey es la dirección de correo electrónico del nuevo miembro o el id único del grupo. Para obtener información sobre 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 grupo, es posible que los miembros del grupo secundario tarden hasta 10 minutos en aparecer 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

La siguiente solicitud JSON muestra un cuerpo de solicitud de ejemplo que crea un miembro del grupo. La dirección de correo electrónico del miembro es liz@example.com y su función 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"
}

La role de un miembro de un grupo puede ser:

  • OWNER: Este rol puede modificar el envío de mensajes al grupo, agregar o quitar miembros, cambiar los roles de los miembros, cambiar la configuración del grupo y borrar el grupo. Un OWNER debe ser miembro del grupo.
  • MANAGER: Este rol solo está disponible si se habilita Google Workspace en la Consola del administrador. Un rol de ADMINISTRADOR puede hacer todo lo que hace un rol de PROPIETARIO, excepto hacer que un miembro sea PROPIETARIO o borrar el grupo. Un grupo puede tener varios miembros OWNER y MANAGER.
  • MEMBER: Este rol permite suscribirse a un grupo, ver los archivos de debate y ver la lista de miembros del grupo. Para obtener más información sobre las funciones de los miembros, consulta el Centro de ayuda para administradores.

Respuesta JSON

Si la respuesta es correcta, se mostrará un código de estado HTTP 200 y la información de la membresía del miembro. El 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"
  }

La type de un miembro de un grupo puede ser:

  • GROUP: el miembro es otro grupo.
  • MEMBER: El miembro es un usuario.

Actualiza la pertenencia a un grupo

Para actualizar una membresía de grupo, usa la siguiente solicitud de PUT e incluye la autorización que se describe en Autoriza 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 grupo, el alias de la dirección de correo electrónico o el id único del usuario. Para obtener información sobre 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

La siguiente solicitud JSON muestra un cuerpo de solicitud de ejemplo que actualiza la configuración de la pertenencia a un grupo. La dirección de correo electrónico del miembro es liz@example.com y su función 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

Si la respuesta es correcta, se mostrará un código de estado HTTP 200 y la información de la membresía actualizada. El 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 una membresía de grupo, usa la siguiente solicitud de GET e incluye la autorización que se describe en Autoriza 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 grupo, el alias de la dirección de correo electrónico o el id único del usuario. Para obtener información sobre 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

Si la respuesta es correcta, se mostrará un código de estado HTTP 200 y la información de la membresía del miembro. El 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"
  }

Recuperar todos los miembros del grupo

Para recuperar todos los miembros del grupo, usa la siguiente solicitud GET y, además, incluye la autorización que se describe en Autoriza solicitudes. groupKey es la dirección de correo electrónico del grupo o la id única del grupo. La cadena de consulta opcional roles es un filtro que te permite recuperar miembros del grupo por función y las colecciones de roles resultantes están en el orden dado en el filtro roles. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de la API. Para facilitar la lectura, en este ejemplo, se usa una línea que muestra lo siguiente: 

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 de las direcciones de correo electrónico de los miembros. Usa la cadena de consulta pageToken para 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 respuestas. En tu próxima solicitud, se usa este token como el valor de 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 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": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "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 e incluye la autorización que se describe en Solicitudes de autorización. groupKey es la id única del grupo, y memberKey es la dirección de correo electrónico principal del usuario o miembro del grupo borrado, o la id única 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 cuya 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.
  • Quitar a un miembro de un grupo no borra la cuenta del usuario.
  • Si borras al propietario del grupo, el grupo seguirá funcionando con normalidad. Como administrador, puedes administrar el grupo o asignar la propiedad a otro miembro del grupo