Method: users.aliases.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Wyświetla wszystkie aliasy użytkownika.
Żądanie HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
userKey |
string
Identyfikuje użytkownika w żądaniu interfejsu API. Wartością może być podstawowy adres e-mail użytkownika, alias adresu e-mail lub unikalny identyfikator użytkownika.
|
Parametry zapytania
| Parametry |
event |
enum (Event)
Zdarzenia, na które należy zwrócić uwagę
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"kind": string,
"etag": string,
"aliases": [
{
object (UserAlias)
}
]
} |
| Pola |
kind |
string
Rodzaj zasobu.
|
etag |
string
ETag zasobu.
|
aliases[] |
object (UserAlias)
Lista obiektów aliasów.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
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
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
Zdarzenie
Typ zdarzenia subskrypcji
| Wartości w polu enum |
ADD |
Zdarzenie utworzenia aliasu |
DELETE |
Wydarzenie usunięcia aliasu |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-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 |"]]
