Method: users.aliases.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mencantumkan semua alias untuk pengguna.
Permintaan HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
userKey |
string
Mengidentifikasi pengguna dalam permintaan API. Nilainya dapat berupa alamat email utama, alamat email alias, atau ID pengguna unik milik pengguna.
|
Parameter kueri
| Parameter |
event |
enum (Event)
Peristiwa yang akan dipantau.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"kind": string,
"etag": string,
"aliases": [
{
object (UserAlias)
}
]
} |
| Kolom |
kind |
string
Jenis resource ini.
|
etag |
string
ETag resource.
|
aliases[] |
object (UserAlias)
Daftar objek alias.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Acara
Jenis peristiwa Langganan
| Enum |
ADD |
Acara yang Dibuat Alias |
DELETE |
Acara Alias Dihapus |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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 |"]]
