API de Directory: Miembros de grupo

Agrega un miembro a un grupo

Para agregar un miembro a un grupo, usa la siguiente solicitud POST y agrega la autorización que se describe en Autoriza solicitudes. Un miembro del grupo puede ser un usuario o algún otro grupo. El 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 API: 

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

Si agregas un grupo como miembro de otro grupo, puede haber 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 la pertenencia a grupos. 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 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:

  • OWNER: Este rol puede cambiar el envío de mensajes al grupo, agregar o quitar miembros, cambiar los roles de los miembros, cambiar la configuración del grupo y borrarlo. Un OWNER debe ser miembro del grupo.
  • MANAGER: Este rol solo está disponible si Google Workspace se habilita a través de la Consola del administrador. Un rol de ADMINISTRADOR puede hacer todo lo que hace un rol de PROPIETARIO, excepto convertir a un miembro en PROPIETARIO o borrar el grupo. Un grupo puede tener varios miembros OWNER y MANAGER.
  • MEMBER: Este rol permite suscribirse a un grupo, ver archivos de debate y ver la lista de miembros del grupo. Para obtener más información sobre los roles de los miembros, consulta el Centro de ayuda de 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 la pertenencia a un grupo

Para actualizar la pertenencia a un grupo, usa la siguiente solicitud PUT y agrega 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 grupo, la dirección de correo electrónico del alias de un 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 una pertenencia a un grupo. La dirección de correo electrónico del miembro es liz@example.com y su rol en el grupo se cambia de MEMBER a MANAGER. El groupKey de la solicitud PUT en este ejemplo es NNNNN. Para obtener información sobre los roles de MEMBER, OWNER y MANAGER, 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 muestra un código de estado HTTP 200 y la información de 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 miembros de un grupo

Para recuperar la pertenencia a un grupo, usa la siguiente solicitud GET y agrega 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, la dirección de correo electrónico del alias de un 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 todos los miembros del grupo

Para recuperar todos los miembros del grupo, usa la siguiente solicitud GET y agrega la autorización que se describe en Autorizar solicitudes. El 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 del grupo por función, y las colecciones de roles resultantes están en el orden indicado en el filtro roles. Para ver las propiedades de solicitud y respuesta, consulta la Referencia de API. Para facilitar la lectura, en este ejemplo se usan resultados de líneas: 

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 devuelven en orden alfabético según la lista de los miembros 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 paginación, la respuesta muestra la propiedad nextPageToken, que tiene un token para la siguiente página de resultados de respuesta. Tu próxima solicitud usará este token como el valor de cadena 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 de miembros. El id es el ID de membresía único del miembro. Hay una 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": "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 de un grupo, usa la siguiente solicitud DELETE y agrega 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 que se borró 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 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

Si la respuesta es correcta, se mostrará un código de estado HTTP 200.

Cuando se borra un miembro, ocurre lo siguiente:

  • Los miembros que quites ya no recibirán los correos electrónicos dirigidos al grupo.
  • Quitar 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 ceder la propiedad a otro miembro del grupo