Users.aliases: list

Lists all aliases for a user. Try it now.


HTTP request



Parameter name Value Description
Path parameters
userKey string Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.


This request requires authorization with at least one of the following scopes:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "admin#directory#aliases",
  "etag": etag,
  "aliases": [
    users.aliases Resource
Property name Value Description Notes
kind string The type of the API resource. For Alias resources, the value is admin#directory#alias.
aliases[] list List of alias objects.
etag etag ETag of the resource.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.