API de Directory: Alias de usuario

Crea un alias de usuario

El alias de un usuario es una dirección de correo electrónico alternativa que usa el mismo buzón de correo que la dirección de correo electrónico principal del usuario. Un alias de usuario se puede asociar con un dominio de cuenta diferente al que usa la dirección de correo electrónico principal del usuario. En un plazo de 24 horas (a menudo, antes), el usuario comienza a recibir correos electrónicos enviados a esta dirección. La API requiere que se confirme la propiedad del dominio antes de que puedas crear el alias de usuario.

Para crear un alias de usuario, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Cómo autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de los correos electrónicos de los alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API: 

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

Solicitud JSON

En la siguiente solicitud JSON, se muestra una solicitud de ejemplo para crear el alias de un usuario. El usuario es liz@example.com y el alias es chica@example.com: 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
 El cuerpo de la solicitud tiene la información del alias nuevo: 
{  
 "alias": "chica@example.com"
}

Una respuesta correcta muestra un código de estado HTTP 201. Junto con el código de estado, la respuesta devuelve las propiedades del alias de usuario nuevo.

Cómo recuperar todos los alias de un usuario

Para recuperar todos los alias de un usuario en todos los dominios, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de los correos electrónicos de los alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
 Por ejemplo, este URI de solicitud muestra todos los alias de la clave de usuario, liz@example.com: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Todos los alias de usuario se muestran en orden alfabético. No hay un tamaño de página, como la cadena de consulta maxResults o la paginación que se usa para la respuesta "Retrieve all aliases".

Respuesta JSON

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra los alias del usuario en orden alfabético. Estos dominios de alias son el dominio principal y otros dominios de la cuenta: 

{
"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"
 }
]
}

Borra el alias de un usuario

Para borrar el alias de un usuario, usa la siguiente solicitud DELETE y, luego, incluye la autorización que se describe en Autorizar solicitudes. El alias puede tardar hasta 24 horas en quitarse. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de los correos electrónicos de los alias del usuario. Y aliasId es la dirección de correo electrónico del alias que se borrará. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
 Por ejemplo, esta solicitud de DELETE borra el alias chica@example.com para el userKey, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Una respuesta correcta muestra un código de estado HTTP 200.