API Directory: alias 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 entrada do 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. A API exige que a propriedade do domínio seja confirmada antes de criar o alias do usuário.

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 do usuário, o id do usuário ou qualquer um dos e-mails de alias do 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 é [email protected] e o alias é [email protected]: 

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases
 O corpo da solicitação tem as novas informações de alias: 
{  
 "alias": "[email protected]"
}

Uma resposta bem-sucedida retorna um código de status HTTP 201. Além do código de status, a resposta retorna as propriedades do novo alias de usuário.

Extrair todos os aliases de um usuário

Para recuperar todos os aliases de um usuário em todos os domínios, use a solicitação GET abaixo e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do 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 para a chave de usuário [email protected]: 
GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/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 a paginação usada para a resposta "Recuperar todos os aliases".

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna os pseudônimos do usuário em ordem alfabética. Esses domínios de alias são o domínio principal e outros domínios na conta: 

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 }
]
}

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. Pode levar até 24 horas para que o alias seja removido. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do 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, esta solicitação DELETE exclui o alias "[email protected]" para a chave de usuário [email protected]: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases/[email protected]

Uma resposta bem-sucedida retorna um código de status HTTP 200.