REST Resource: users.aliases
Stay organized with collections
Save and categorize content based on your preferences.
Resource: UserAlias
The Directory API manages aliases, which are alternative email addresses.
| JSON representation |
{
"id": string,
"primaryEmail": string,
"alias": string,
"kind": string,
"etag": string
} |
| Fields |
id |
string
The unique ID for the user.
|
primaryEmail |
string
The user's primary email address.
|
alias |
string
The alias email address.
|
kind |
string
The type of the API resource. For Alias resources, the value is admin#directory#alias.
|
etag |
string
ETag of the resource.
|
Methods |
|
|
Removes an alias. |
|
|
Adds an alias. |
|
|
Lists all aliases for a user. |
|
|
Watches for changes in users list. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# REST Resource: users.aliases\n\nResource: UserAlias\n-------------------\n\nThe Directory API manages aliases, which are alternative email addresses.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"primaryEmail\": string, \"alias\": string, \"kind\": string, \"etag\": string } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------|\n| `id` | `string` The unique ID for the user. |\n| `primaryEmail` | `string` The user's primary email address. |\n| `alias` | `string` The alias email address. |\n| `kind` | `string` The type of the API resource. For Alias resources, the value is `admin#directory#alias`. |\n| `etag` | `string` ETag of the resource. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------|------------------------------------|\n| ### [delete](/workspace/admin/directory/reference/rest/v1/users.aliases/delete) | Removes an alias. |\n| ### [insert](/workspace/admin/directory/reference/rest/v1/users.aliases/insert) | Adds an alias. |\n| ### [list](/workspace/admin/directory/reference/rest/v1/users.aliases/list) | Lists all aliases for a user. |\n| ### [watch](/workspace/admin/directory/reference/rest/v1/users.aliases/watch) | Watches for changes in users list. |"]]
