با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
یک نام مستعار کاربری ایجاد کنید
نام مستعار کاربر یک آدرس ایمیل جایگزین است که از همان صندوق پستی استفاده شده توسط آدرس ایمیل اصلی کاربر استفاده می کند. نام مستعار کاربر می تواند با دامنه حساب متفاوتی نسبت به دامنه مورد استفاده توسط آدرس ایمیل اصلی کاربر مرتبط شود. در عرض 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 مراجعه کنید.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[],[],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."]]
