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 descrita en Autorizar solicitudes. Un miembro del grupo puede ser un usuario o bien otro grupo. groupKey es la dirección de correo electrónico del grupo del nuevo miembro 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 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 devuelve un error para los ciclos en las membresías de grupos. 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 ejemplo 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 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 uno de los siguientes:

  • OWNER: Este rol puede cambiar los mensajes que se envían 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 Google Workspace está habilitado a través de la Consola del administrador de Google. 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 con los roles de PROPIETARIO y ADMINISTRADOR.
  • MEMBER: Este rol puede suscribirse a un grupo, ver los archivos de discusión y la lista de miembros del grupo. Para obtener más información sobre los roles de los miembros, consulta el Centro de ayuda para administradores.

Respuesta JSON

Una respuesta correcta devuelve 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"
  }

El type de un miembro del grupo puede ser uno de los siguientes:

  • 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 e incluye la autorización descrita en Autorizar solicitudes. El groupKey es la dirección de correo electrónico del grupo o su id único, y el memberKey es la dirección de correo electrónico principal del usuario o grupo, la dirección de correo electrónico de alias de un 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

La siguiente solicitud en formato JSON muestra un cuerpo de solicitud de ejemplo 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 cambió 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 para administradores: 

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 devuelve 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"
  }

Recupera un miembro de un grupo

Para recuperar la membresía de un 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 su id único, y el memberKey es la dirección de correo electrónico principal del usuario o grupo, la dirección de correo electrónico de alias de un 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 devuelve 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"
  }

Recupera 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. groupKey es la dirección de correo electrónico del grupo o su id único. La cadena de consulta roles opcional es un filtro que te permite recuperar miembros del grupo por rol, y las colecciones de roles resultantes se encuentran 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. Y usa la cadena de consulta pageToken para las respuestas con una gran cantidad de miembros. En el caso de la paginación, la respuesta devuelve 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 devuelve un código de estado HTTP 200 y la lista de información de los miembros. El id es el ID de membresía único del miembro. Hay un nextPageToken para la lista de miembros del grupo de seguimiento 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"
}

Borra la membresía en un grupo

Para borrar la membresía de un miembro en un grupo, usa la siguiente solicitud DELETE e incluye la autorización descrita 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 borrado, o bien 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 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

Una respuesta correcta devuelve 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 su cuenta de 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 del grupo.