API de Directory: alias de usuario

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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 a un dominio de cuenta diferente del que usa la dirección de correo electrónico principal del usuario. El usuario comienza a recibir correos electrónicos enviados a esta dirección en un plazo de 24 horas (a menudo, antes). 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 e incluye la autorización descrita en Autorizar solicitudes. El userKey puede ser la dirección de correo electrónico principal del usuario, el usuario id o cualquiera de los correos electrónicos del alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de API:

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

Solicitud JSON

La siguiente solicitud JSON muestra una solicitud de muestra 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"
}

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

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 descrita en Autorizar solicitudes. El userKey puede ser la dirección de correo electrónico principal del usuario, el usuario id o cualquiera de los correos electrónicos del alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la Referencia de 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 string de consulta maxResults o la paginación que se usó para la respuesta "Recuperar todos los alias".

Respuesta JSON

Si la respuesta es correcta, se 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 son los dominios principales 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"
 }
]
}

Borrar el alias de un usuario

Para borrar un alias de usuario, usa la siguiente solicitud DELETE e incluye la autorización descrita en Autorizar solicitudes. El alias puede tardar hasta 24 horas en quitarse. El userKey puede ser la dirección de correo electrónico principal del usuario, el usuario id o cualquiera de los correos electrónicos del 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 de userKey, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Si la respuesta es correcta, se muestra un código de estado HTTP 200.