یک نام مستعار کاربری ایجاد کنید
نام مستعار کاربر یک آدرس ایمیل جایگزین است که از همان صندوق پستی استفاده شده توسط آدرس ایمیل اصلی کاربر استفاده می کند. نام مستعار کاربر می تواند با دامنه حساب متفاوتی نسبت به دامنه مورد استفاده توسط آدرس ایمیل اصلی کاربر مرتبط شود. در عرض 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 مراجعه کنید.
DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasIdبرای مثال، این درخواست
DELETE نام مستعار chica@example.com را برای userKey، liz@example.com حذف می‌کند:DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com
یک پاسخ موفق یک کد وضعیت HTTP 200 را برمی گرداند.