Method: users.aliases.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all aliases for a user.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases
The URL uses gRPC Transcoding syntax.
Path parameters
| 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.
|
Query parameters
| Parameters |
event |
enum (Event)
Events to watch for.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"aliases": [
{
object (UserAlias)
}
]
} |
| Fields |
kind |
string
Kind of resource this is.
|
etag |
string
ETag of the resource.
|
aliases[] |
object (UserAlias)
A list of alias objects.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://apps-apis.google.com/a/feeds/alias/
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.alias
https://www.googleapis.com/auth/admin.directory.user.alias.readonly
https://www.googleapis.com/auth/admin.directory.user.readonly
For more information, see the Authorization guide.
Event
Type of the Subscription event
| Enums |
ADD |
Alias Created Event |
DELETE |
Alias Deleted Event |
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,["# Method: users.aliases.list\n\nLists all aliases for a user.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n### Query parameters\n\n| Parameters ||\n|---------|----------------------------------------------------------------------------------------------------------------|\n| `event` | `enum (`[Event](/workspace/admin/directory/reference/rest/v1/users.aliases/list#Event)`)` Events to watch for. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"aliases\": [ { object (/workspace/admin/directory/reference/rest/v1/users.aliases#UserAlias) } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `aliases[]` | `object (`[UserAlias](/workspace/admin/directory/reference/rest/v1/users.aliases#UserAlias)`)` A list of alias objects. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/alias/`\n- `\n https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.alias`\n- `\n https://www.googleapis.com/auth/admin.directory.user.alias.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nEvent\n-----\n\nType of the Subscription event\n\n| Enums ||\n|----------|---------------------|\n| `ADD` | Alias Created Event |\n| `DELETE` | Alias Deleted Event |"]]
