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 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.