API de Directory: miembros del grupo

Cómo agregar 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 u otro grupo. El groupKey es la dirección de correo electrónico del grupo del nuevo miembro o la id única del grupo. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de API: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

Si agregas un grupo como miembro de otro grupo, 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 de 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 muestra 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 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:

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

Respuesta JSON

Si la respuesta es correcta, se muestra un código de estado HTTP 200 y la información de 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"
  }

El type de un miembro del grupo puede ser:

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

Cómo actualizar una membresía de grupo

Para actualizar una membresía de grupo, usa la siguiente solicitud PUT e incluye la autorización descrita en Autorizar solicitudes. El groupKey es la dirección de correo electrónico del grupo o la id única del grupo, y el memberKey es la dirección de correo electrónico principal del usuario o del grupo, la dirección de correo electrónico del alias del usuario o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de 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 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 función en el grupo cambió de MEMBER a MANAGER. El groupKey de la solicitud PUT en este ejemplo es NNNNN. Para obtener información acerca de las funciones MEMBER, OWNER y MANAGER, consulta el Centro de ayuda para la 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 muestra un código de estado HTTP 200 y la información actualizada de la membresía. 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 un miembro del grupo

Para recuperar una membresía de grupo, usa la siguiente solicitud GET e incluye la autorización descrita en Autorizar solicitudes. El groupKey es la dirección de correo electrónico del grupo o la id única del grupo, y el memberKey es la dirección de correo electrónico principal del usuario o del grupo, la dirección de correo electrónico del alias del usuario o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de API: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Respuesta JSON

Si la respuesta es correcta, se muestra un código de estado HTTP 200 y la información de 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 a todos los miembros del grupo

Para recuperar todos los miembros del grupo, usa la siguiente solicitud GET e incluye la autorización descrita en Autorizar solicitudes. El groupKey es la dirección de correo electrónico del grupo o la id única del grupo. La string de consulta opcional roles es un filtro que te permite recuperar miembros del grupo por función y las colecciones de funciones resultantes están en el orden dado en el filtro roles. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de API. Para mayor legibilidad, en este ejemplo, se usan 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 de las direcciones de correo electrónico de los miembros. Y usa la string 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 página siguiente de resultados de la respuesta. Tu próxima solicitud usa este token como el valor de string de consulta pageToken.

Respuesta JSON

Si la respuesta es correcta, se muestra un código de estado HTTP 200 y la lista de información del miembro. El id es el ID de membresía único del miembro. Hay una 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": "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 Autoriza solicitudes. El groupKey es el id único del grupo y memberKey es la dirección de correo electrónico principal del usuario o miembro borrado del grupo o el id único del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de API: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Por ejemplo, esta solicitud DELETE borra al 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, sucede lo siguiente:

  • Los miembros que quites ya no recibirán los 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, el grupo seguirá funcionando normalmente. Como administrador, puedes administrar el grupo o asignar la propiedad a otro miembro del grupo