קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
יצירת כתובת אימייל חלופית של משתמש
כתובת האימייל החלופית של משתמש היא כתובת אימייל חלופית שמשתמשת באותה תיבת דואר שבה משתמשים בכתובת האימייל הראשית של המשתמש. אפשר לשייך כתובת אימייל חלופית לדומיין חשבון שונה מהדומיין שבו נעשה שימוש בכתובת האימייל הראשית של המשתמש. תוך 24 שעות (לרוב מוקדם יותר), המשתמש מתחיל לקבל אימיילים שנשלחים לכתובת הזו. כדי ליצור את הכינוי של המשתמש, נדרש אישור הבעלות על הדומיין ב-API.
כדי ליצור כינוי משתמש, משתמשים בבקשת POST הבאה וכוללים את ההרשאה שמתוארת בקטע בקשות לאישור. השדה userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחד מהאימיילים של כתובות האימייל החלופיות של המשתמש. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
בקשת JSON
בקשת ה-JSON הבאה היא דוגמה לבקשה ליצירת כינוי של משתמש. שם המשתמש הוא liz@example.com והכינוי הוא chica@example.com:
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
גוף הבקשה מכיל את פרטי הכינוי החדש:
{"alias":"chica@example.com"}
תגובה מוצלחת מחזירה את קוד הסטטוס HTTP 201. התשובה מחזירה את המאפיינים של הכינוי החדש של המשתמש, יחד עם קוד הסטטוס.
אחזור כל כינויי המשתמש
כדי לאחזר את כל כתובות האימייל החלופיות של משתמש בכל הדומיינים, משתמשים בבקשה הבאה של GET וכוללים את ההרשאה שמתוארת בקטע אימות בקשות. השדה userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחד מהאימיילים של כתובות האימייל החלופיות של המשתמש. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API:
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
לדוגמה, ה-URI של הבקשה הזו מחזיר את כל כתובות האימייל החלופיות של userKey, liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
כל כינויי המשתמשים מופיעים בסדר אלפביתי. אין גודל דף, כמו מחרוזת השאילתה maxResults או חלוקה לדפים, שמשמש בתגובה של 'אחזור כל כתובות האימייל החלופיות'.
תגובת JSON
תגובה מוצלחת מחזירה קוד סטטוס HTTP 200. יחד עם קוד הסטטוס, התגובה מחזירה את כינויי המשתמש בסדר אלפביתי. דומיינים חלופיים הם הדומיין הראשי ועוד כמה דומיינים בחשבון:
{"kind":"directory#user#aliases","aliases":[ { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "chica@example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "support@example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "help@hr.example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "tickets@jumboinc.com" }]}
מחיקת כתובת אימייל חלופית של משתמש
כדי למחוק כתובת אימייל חלופית של משתמש, משתמשים בבקשה הבאה מסוג DELETE וכוללים את ההרשאה שמתוארת בקטע בקשות לאישור. יכולות לחלוף לכל היותר 24 שעות עד שהכתובת החלופית תוסר. הערך של userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחת מכתובות האימייל החלופיות של המשתמש. הערך aliasId הוא כתובת האימייל החלופית שנמחקת. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API.
[null,null,["עדכון אחרון: 2025-08-29 (שעון UTC)."],[],[],null,["# Directory API: User Aliases\n\nCreate a user alias\n-------------------\n\nA user's alias is an alternate email address that uses the same mailbox used by the user's\nprimary email address. A user alias can be associated with a different account domain than that\ndomain used by the user's primary email address. Within 24 hours (often sooner), the user begins\nreceiving email sent to this address. The API requires that the\n[domain's ownership is confirmed](https://support.google.com/a/bin/answer.py?lev=index&cbid=sm2s8vsdlrxw&answer=60216&src=cb)\nbefore you can create the user alias.\n| **Note:** The maximum number of aliases per user is 30.\n\nTo create a user alias, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `userKey` can be the user's primary email address, the user `id`, or any of the user aliases' emails. For the request and response properties, see the [API Reference](/workspace/admin/directory/reference/rest/v1/users.aliases/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases\n```\n\n### JSON request\n\nThe following JSON request shows a sample request to create a user's alias. The user is liz@example.com and the alias is chica@example.com: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases\n```\nThe request body has the new alias information: \n\n```transact-sql\n{ \n \"alias\": \"chica@example.com\"\n}\n```\n\nA successful response returns an [HTTP 201 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes). Along with the status code, the response returns the properties for the new user alias.\n\nRetrieve all of a user's aliases\n--------------------------------\n\nTo retrieve all of a user's aliases across all domains, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `userKey` can be the user's primary email address, the user `id`, or any of the user aliases' emails. For the request and response properties, see the [API Reference](/workspace/admin/directory/reference/rest/v1/users.aliases/list): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases\n```\nFor example, this request URI returns all aliases for the userKey, liz@example.com: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases\n```\n\nAll user aliases are returned in alphabetical order. There is no page size such as the `maxResults` query string or pagination used for the 'Retrieve all aliases' response.\n| **Note:** These are editable user email alias in the account's primary domain or subdomains. For user aliases outside of the account, see the [user's nonEditableAliases property](/workspace/admin/directory/v1/reference/users#nonEditableAliases).\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes). Along with the status code, the response returns the user's aliases in alphabetical order. These alias domains are the primary domain and other multiple domains in the account: \n\n```transact-sql\n{\n\"kind\": \"directory#user#aliases\",\n\"aliases\": [\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"chica@example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"support@example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"help@hr.example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"tickets@jumboinc.com\"\n }\n]\n}\n```\n\nDelete a user's alias\n---------------------\n\nTo delete a user alias, use the following `DELETE` request and include the\nauthorization described in\n[Authorize requests](/workspace/admin/directory/v1/guides/authorizing). It can take up\nto 24 hours for the alias to be removed. The\n`userKey` can be the user's primary email address, the user `id`, or any of\nthe user aliases' emails. And the `aliasId` is the alias' email address that is being\ndeleted. For the request and response properties, see the\n[API reference](/workspace/admin/directory/reference/rest/v1/users.aliases/delete). \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId\n```\nFor example, this `DELETE` request deletes the chica@example.com alias for the userKey, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n| **Note:** Deleting a user's alias, does not delete the user. A deleted user alias can be used again as another user's alias immediately."]]
