Administrar grupos

En esta página, se explica cómo administrar Grupos de Google con la API de Directory:

  • Crear un grupo
  • Actualizar un grupo
  • Agregar un alias de grupo
  • Cómo recuperar un grupo
  • Recupera todos los grupos de un dominio o una cuenta.
  • Recupera todos los grupos de un miembro
  • Recupera todos los alias de grupos
  • Cómo borrar un alias de grupo
  • Cómo borrar un grupo

Crear un grupo

Para crear un grupo, usa la siguiente solicitud POST y agrega la autorización descritos en Autoriza solicitudes. Puedes crear un grupo para cualquier dominio asociado con la cuenta. Para las cadenas de consulta, request, y propiedades de respuesta, consulta la Método groups.insert. 

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

La siguiente solicitud JSON muestra un cuerpo de solicitud de muestra que crea un grupo. El correo electrónico del grupo la dirección es grupo_ventas@example.com: 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Una respuesta correcta devuelve un Código de estado HTTP 201 y las propiedades del grupo nuevo.

Actualizar un grupo

Para actualizar la configuración de un grupo, usa la siguiente solicitud PUT y agrega lo siguiente: autorización descrita en Autoriza solicitudes. groupKey es la dirección de correo electrónico del grupo, cualquiera de las direcciones del alias del grupo. o el id único del grupo. Para las cadenas de consulta, solicitud y propiedades de respuesta, consulta la Método groups.update. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey

En general, Google recomienda no usar la dirección de correo electrónico del grupo como clave para datos persistentes porque la dirección de correo electrónico está sujeta a cambios.

En el siguiente ejemplo, el groupKey único es nnn y el el nombre es APAC Sales Group: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

Para solicitar una actualización, solo debes enviar la información actualizada en ella. No debes ingresar todas las propiedades del grupo en la solicitud.

Una respuesta correcta devuelve un Código de estado HTTP 201 y las propiedades del grupo nuevo: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Agregar un alias de grupo

Para agregar un alias de grupo, usa la siguiente solicitud POST e incluye la autorización se describe en Autoriza solicitudes. El groupKey es la dirección de correo electrónico del grupo, cualquiera de los alias del grupo. dirección de correo electrónico la id única del grupo. Para conocer las propiedades de cadena de consulta, solicitud y respuesta, consulta el recurso groups. 

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

En general, Google recomienda no usar la dirección de correo electrónico del grupo como clave para datos persistentes porque la dirección de correo electrónico está sujeta a cambios.

La siguiente solicitud JSON muestra una solicitud de ejemplo para crear un alias de grupo. El groupKey es el id único del grupo que se representa con NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Una respuesta correcta devuelve un Código de estado HTTP 201 y las propiedades del nuevo alias de grupo.

Cómo recuperar un grupo

Para recuperar un grupo, usa la siguiente solicitud GET y agrega la autorización descritos en Autoriza solicitudes. El groupKey es la dirección de correo electrónico del grupo, cualquiera de los alias del grupo. dirección de correo electrónico la id única del grupo. Para conocer las propiedades de cadena de consulta, solicitud y respuesta, consulta Usa el método groups.get. 
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

En general, Google recomienda no usar la dirección de correo electrónico del grupo como clave para datos persistentes porque la dirección de correo electrónico está sujeta a cambios.

En el siguiente ejemplo, el ID de groupKey único es nnnn: 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Una respuesta correcta devuelve un Código de estado HTTP 200 y la configuración del grupo: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Recupera todos los grupos de un dominio o una cuenta.

Para recuperar todos los grupos de un dominio o una cuenta específicos, usa el siguiente GET: solicitud e incluir la autorización descrita en Autoriza solicitudes. Para la consulta cadenas, solicitudes y propiedades de respuesta, consulta la Método groups.list. Para facilitar la lectura, en este ejemplo se usan resultados de líneas: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Cuando recuperes todos los grupos de un dominio o una cuenta, ten en cuenta lo siguiente:

  • Todos los grupos de un subdominio: Usa el argumento domain con el nombre del dominio.
  • Todos los grupos de la cuenta: Usa el argumento customer con my_customer o el valor de customerId de la cuenta. Como una cuenta administrador, utiliza la cadena my_customer para representar el dominio customerId Si usted es un distribuidor y está accediendo a la cuenta de un cliente de reventa, use el customerId de la cuenta de reventa. Para el valor customerId, usa la nombre de dominio principal de la cuenta Recupera todos los usuarios de un dominio cada solicitud de la operación. La respuesta resultante tiene el valor customerId.
  • Con los argumentos domain y customer, la La API de Directory muestra todos los grupos para domain.
  • Si no se usan los argumentos domain y customer, la La API de Directory devuelve todos los grupos para la cuenta asociada con my_customer Esta es la cuenta customerId del administrador que está creando la solicitud.
  • Con los argumentos customer y userKey, la La API de Directory muestra un error. Debes hacer dos solicitudes separadas con estas argumentos.

En el siguiente ejemplo, un administrador de cuenta usa my_customer para solicitar una lista de todos los grupos de una cuenta:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

En el siguiente ejemplo, la solicitud de un administrador revendedor devuelve todos los grupos de la cuenta de reventa. con el customerId C03az79cb. La cantidad máxima de resultados que se muestra por página de respuesta es 2. Hay una nextPageToken para la lista de seguimiento de usuarios en esta respuesta: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Una respuesta correcta devuelve un Código de estado HTTP 200 y los grupos en orden alfabético del correo electrónico de grupo: 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Recupera todos los grupos de un miembro

Para recuperar todos los grupos a los que un miembro tiene una suscripción, usa el siguiente GET: solicitud e incluir la autorización descrita en Autoriza solicitudes. Para mayor legibilidad, en este ejemplo, se usan retornos de línea: 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page
  • Un miembro puede ser un usuario o un grupo.
  • userKey puede ser la dirección de correo electrónico principal del usuario, la dirección de correo electrónico del alias del usuario. la dirección de correo electrónico principal de un grupo, el alias de correo electrónico de un grupo o el id único del usuario que puedes encontrar usando Recupera una operación de usuario.
  • El usuario o grupo especificado en el archivo userKey debe pertenecer a tu dominio.
  • Usa la cadena de consulta pageToken para las respuestas con una gran cantidad de grupos. En la caso de paginación, la respuesta muestra la propiedad nextPageToken, que proporciona un token de la siguiente página de resultados de respuesta. Tu próxima solicitud usará este token como Valor de cadena de consulta pageToken.
  • Con los argumentos customer y userKey, la La API de Directory muestra un error. Debes hacer dos solicitudes separadas con estas argumentos.

Para conocer las propiedades de solicitud y respuesta, consulta la Método groups.list.

Una respuesta correcta devuelve un Código de estado HTTP 200 y la lista de información de los miembros:

  • Todos los grupos a los que un miembro tiene una suscripción, incluidos los grupos que no pertenecen al dominio del el dominio correspondiente.
  • Los grupos se devuelven en orden alfabético según la dirección de correo electrónico de cada grupo.
  • En el cuerpo de la respuesta, id es el ID único del grupo.
  • En la respuesta, la ficha de un grupo ajeno al dominio del usuario no incluye el alias de un grupo externo. 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Recupera todos los alias de grupos

Para recuperar todos los alias de un grupo, usa la siguiente solicitud GET y agrega el autorización descrita en Autoriza solicitudes. El groupKey puede ser la dirección de correo electrónico principal del grupo, la dirección única id o cualquiera de los alias del grupo correos electrónicos. Para conocer las propiedades de solicitud y respuesta, consulta el recurso groups. 

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

Una respuesta correcta devuelve un Código de estado HTTP 201 y una lista de los alias del grupo.

Cómo borrar un alias de grupo

Para borrar el alias de un grupo, usa la siguiente solicitud DELETE y agrega el autorización descrita en Autoriza solicitudes. El groupKey puede ser la dirección de correo electrónico principal del grupo, la dirección única id o cualquiera de los alias del grupo correos electrónicos. aliasId es el alias que se borrar. Para conocer las propiedades de solicitud y respuesta, consulta el recurso groups: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Una respuesta correcta devuelve un Código de estado HTTP 201.

Cómo borrar un grupo

Para borrar un grupo, usa la siguiente solicitud DELETE y agrega la autorización descritos en Autoriza solicitudes. El groupKey es el id único del grupo: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
 Por ejemplo, esta solicitud DELETE borra el grupo que tiene el grupo nnnn id: 
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Una respuesta correcta devuelve un Código de estado HTTP 200.

Cuando se borra un grupo, sucede lo siguiente:

  • Se borrarán todos los miembros del grupo. Las cuentas de usuario del miembro no se borrarán.
  • Se borró el archivo del grupo.
  • No se entregarán los mensajes enviados a la dirección del grupo borrado. En cambio, el remitente recibe un mensaje de rebote.