REST Resource: groups

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: Group

Grupos de Google permite a sus usuarios enviar mensajes a grupos de personas mediante la dirección de correo electrónico del grupo. Para obtener más información sobre las tareas comunes, consulta la Guía para desarrolladores.

Para obtener información sobre otros tipos de grupos, consulta la documentación de la API de Cloud Identity Groups.

Nota: El usuario que llama a la API (o que suplanta una cuenta de servicio) debe tener una función asignada que incluya permisos para los grupos de API de administrador, como Administrador avanzado o Administrador de grupos.

Representación JSON
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Campos
id

string

Solo lectura El ID único de un grupo. Se puede usar un grupo id como el URI de una solicitud de grupo groupKey.

email

string

La dirección de correo electrónico del grupo. Si su cuenta tiene varios dominios, seleccione el dominio adecuado para la dirección de correo electrónico. El elemento email debe ser único. Esta propiedad es obligatoria cuando se crea un grupo. Las direcciones de correo electrónico de los grupos están sujetas a las mismas reglas de uso de caracteres que los nombres de usuario. Consulta el Centro de ayuda para obtener más información.

name

string

El nombre visible del grupo.

description

string

Una descripción extendida para ayudar a los usuarios a determinar el propósito de un grupo Por ejemplo, puedes incluir información sobre quién debe unirse al grupo, los tipos de mensajes que se enviarán al grupo, los vínculos a las preguntas frecuentes sobre el grupo o los grupos relacionados. La longitud máxima es de 4,096 caracteres.

adminCreated

boolean

Solo lectura El valor es true si el administrador creó este grupo en lugar de un usuario.

directMembersCount

string (int64 format)

Cantidad de usuarios que son miembros directos del grupo. Si un grupo es miembro (secundario) de este grupo (el principal), los miembros del grupo secundario no se cuentan en la propiedad directMembersCount del grupo superior.

kind

string

Tipo de recurso de la API. Para los recursos de Grupos, el valor es admin#directory#group.

etag

string

ETag del recurso.

aliases[]

string

Solo lectura La lista de las direcciones de correo electrónico del alias de un grupo. Para agregar, actualizar o quitar los alias de un grupo, usa los métodos groups.aliases. Si se edita en la solicitud PUT o PUT de un grupo, se ignora la edición.

nonEditableAliases[]

string

Solo lectura La lista de las direcciones de correo electrónico de alias no editables del grupo que están fuera del dominio principal o de los subdominios de la cuenta. Estas son direcciones de correo electrónico en funcionamiento que utiliza el grupo. Esta es una propiedad de solo lectura que se muestra en la respuesta de la API para un grupo. Si se edita en la solicitud PUT o PUT de un grupo, se ignora la edición.

Métodos

delete

Borra un grupo.

get

Recupera las propiedades de un grupo.

insert

Crea un grupo.

list

Recupera todos los grupos de un dominio o de un usuario a partir de una userKey (paginada).

patch

Actualiza las propiedades de un grupo.

update

Actualiza las propiedades de un grupo.