REST Resource: groups

Recurso: Group

Com os Grupos do Google, seus usuários podem enviar mensagens para grupos de pessoas usando o endereço de e-mail do grupo. Para saber mais sobre tarefas comuns, consulte o Guia para desenvolvedores.

Para informações sobre outros tipos de grupos, consulte a documentação da API Cloud Identity Groups.

Observação: o usuário que chama a API (ou é representado por uma conta de serviço) precisa ter uma função atribuída que inclua permissões dos grupos de APIs Admin, como superadministrador ou administrador de grupos.

Representação JSON
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Campos
id

string

Somente leitura. O ID exclusivo de um grupo. Um id de grupo pode ser usado como o groupKey de um URI de solicitação de grupo.

email

string

O endereço de e-mail do grupo. Se a conta tiver vários domínios, selecione o domínio apropriado para o endereço de e-mail. O email precisa ser exclusivo. Essa propriedade é obrigatória ao criar um grupo. Os endereços de e-mail de grupo estão sujeitos às mesmas regras de uso de caracteres que os nomes de usuário. Consulte a Central de Ajuda para mais detalhes.

name

string

O nome de exibição do grupo.

description

string

Uma descrição estendida para ajudar os usuários a determinar a finalidade de um grupo. Por exemplo, inclua informações sobre quem deve participar do grupo, os tipos de mensagens a serem enviadas, links para perguntas frequentes sobre o grupo ou grupos relacionados. O nome deve ter no máximo 4,096 caracteres.

adminCreated

boolean

Somente leitura. O valor será true se o grupo tiver sido criado por um administrador, e não por um usuário.

directMembersCount

string (int64 format)

O número de usuários que são membros diretos do grupo. Se um grupo for participante (filho) do grupo pai (pai), os participantes do filho não vão ser contados na propriedade directMembersCount do grupo pai.

kind

string

O tipo do recurso da API. Para recursos de Grupos, o valor é admin#directory#group.

etag

string

ETag do recurso.

aliases[]

string

Somente leitura. A lista dos endereços de e-mail do alias de um grupo. Para adicionar, atualizar ou remover os aliases de um grupo, use os métodos groups.aliases. Se for editada na solicitação POST ou PUT de um grupo, a edição será ignorada.

nonEditableAliases[]

string

Somente leitura. A lista de endereços de e-mail de alias não editáveis do grupo que estão fora do domínio principal ou dos subdomínios da conta. Esses endereços de e-mail funcionam e são usados pelo grupo. Essa é uma propriedade somente leitura retornada na resposta da API para um grupo. Se for editada na solicitação POST ou PUT de um grupo, a edição será ignorada.

Métodos

delete

Exclui um grupo.

get

Recupera as propriedades de um grupo.

insert

Cria um grupo.

list

Recupera todos os grupos de um domínio ou de um usuário com uma userKey (paginada).

patch

Atualiza as propriedades de um grupo.

update

Atualiza as propriedades de um grupo.