Directory API: User Aliases

Create a user alias

A user's alias is an alternate email address that uses the same mailbox used by the user's primary email address. A user alias can be associated with a different account domain than that domain used by the user's primary email address. Within 24 hours (often sooner), the user begins receiving email sent to this address. The API requires that the domain's ownership is confirmed before you can create the user alias.

To create a user alias, use the following POST request and include the authorization described in Authorize requests. The userKey can be the user's primary email address, the user id, or any of the user aliases' emails. For the request and response properties, see the API Reference:

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

JSON request

The following JSON request shows a sample request to create a user's alias. The user is [email protected] and the alias is [email protected]:

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases

The request body has the new alias information:

{  
 "alias": "[email protected]"
}

A successful response returns an HTTP 201 status code. Along with the status code, the response returns the properties for the new user alias.

Retrieve all of a user's aliases

To retrieve all of a user's aliases across all domains, use the following GET request and include the authorization described in Authorize requests. The userKey can be the user's primary email address, the user id, or any of the user aliases' emails. For the request and response properties, see the API Reference:

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

For example, this request URI returns all aliases for the userKey, [email protected]:

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases

All user aliases are returned in alphabetical order. There is no page size such as the maxResults query string or pagination used for the 'Retrieve all aliases' response.

JSON response

A successful response returns an HTTP 200 status code. Along with the status code, the response returns the user's aliases in alphabetical order. These alias domains are the primary domain and other multiple domains in the account:

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

Delete a user's alias

To delete a user alias, use the following DELETE request and include the authorization described in Authorize requests. It can take up to 24 hours for the alias to be removed. The userKey can be the user's primary email address, the user id, or any of the user aliases' emails. And the aliasId is the alias' email address that is being deleted. For the request and response properties, see the API reference.

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

For example, this DELETE request deletes the [email protected] alias for the userKey, [email protected]:

DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases/[email protected]

A successful response returns an HTTP 200 status code.