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 que usa la dirección de correo electrónico principal del usuario. Un alias de usuario se puede asociar con un dominio de cuenta diferente del que usa la dirección de correo electrónico principal del usuario. Dentro de las 24 horas (a menudo antes), el usuario comienza a recibir los correos electrónicos que se envían a esta dirección. La API requiere que se confirme la propiedad del dominio para 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 Autoriza solicitudes. El 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 obtener información sobre 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

La siguiente solicitud JSON 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 nueva información de alias: 
{  
 "alias": "chica@example.com"
}

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

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 e incluye la autorización que se describe en Autoriza solicitudes. El 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 obtener información sobre 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 userKey, 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 "Recuperar todos los alias".

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 múltiples 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 un alias de usuario, usa la siguiente solicitud DELETE y, luego, incluye la autorización que se describe en Autoriza solicitudes. Quitar el alias puede tardar hasta 24 horas. El 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 está borrando. 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 DELETE borra el alias chica@example.com para 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.