API Directory: aliases de usuário

Criar um alias de usuário

O alias de um usuário é um endereço de e-mail alternativo que usa a mesma caixa de e-mails usada pelo endereço de e-mail principal. Um alias de usuário pode ser associado a um domínio de conta diferente daquele usado pelo endereço de e-mail principal do usuário. Em 24 horas (geralmente antes disso), o usuário começa a receber os e-mails enviados para esse endereço. Antes de criar o alias de usuário, a API exige que a propriedade do domínio seja confirmada.

Para criar um alias de usuário, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal, o id ou qualquer um dos aliases de usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API: 

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

Solicitação JSON

A solicitação JSON a seguir mostra um exemplo de solicitação para criar o alias de um usuário. O usuário é liz@example.com e o alias é chica@example.com: 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
O corpo da solicitação tem as novas informações do alias: 
{  
 "alias": "chica@example.com"
}

Se a resposta for bem-sucedida, o código de status HTTP 201 será retornado. Juntamente com o código de status, a resposta retorna as propriedades do novo alias de usuário.

Recuperar todos os aliases de um usuário

Para recuperar todos os aliases de um usuário em todos os domínios, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal, o id ou qualquer um dos aliases de usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Por exemplo, este URI de solicitação retorna todos os aliases de userKey, liz@example.com: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
.

Todos os aliases de usuário são retornados em ordem alfabética. Não há tamanho de página, como a string de consulta maxResults ou paginação usada para a resposta "Recuperar todos os aliases".

Resposta JSON

Se a resposta for bem-sucedida, o código de status HTTP 200 será retornado. Junto com o código de status, a resposta retorna os aliases do usuário em ordem alfabética. Esses domínios de alias são o domínio principal e outros domínios múltiplos na conta: 

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

Excluir o alias de um usuário

Para excluir um alias de usuário, use a seguinte solicitação DELETE e inclua a autorização descrita em Autorizar solicitações. A remoção do alias pode levar até 24 horas. O userKey pode ser o endereço de e-mail principal, o id ou qualquer um dos e-mails dos aliases de usuário. E aliasId é o endereço de e-mail do alias que está sendo excluído. Para as propriedades de solicitação e resposta, consulte a referência da API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Por exemplo, a solicitação DELETE exclui o alias chica@example.com da chave userKey, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Se a resposta for bem-sucedida, o código de status HTTP 200 será retornado.