Method: users.aliases.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הצגת הרשימה של כל כתובות האימייל החלופיות של משתמש.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
userKey |
string
מזהה את המשתמש בבקשת ה-API. הערך יכול להיות כתובת האימייל הראשית של המשתמש, כתובת אימייל חלופית או מזהה משתמש ייחודי.
|
פרמטרים של שאילתה
| פרמטרים |
event |
enum (Event)
אירועים שכדאי לעקוב אחריהם.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"kind": string,
"etag": string,
"aliases": [
{
object (UserAlias)
}
]
} |
| שדות |
kind |
string
סוג המשאב.
|
etag |
string
ה-ETag של המשאב.
|
aliases[] |
object (UserAlias)
רשימה של אובייקטים של כתובות אימייל חלופיות.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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
מידע נוסף זמין במדריך ההרשאות.
אירוע
| טיפוסים בני מנייה (enum) |
ADD |
אירוע שנוצר בכתובת אימייל חלופית |
DELETE |
אירוע של מחיקת כתובת אימייל חלופית |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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 |"]]
