Directory API: نام مستعار کاربر

ایجاد نام مستعار کاربر

نام مستعار کاربر، یک آدرس ایمیل جایگزین است که از همان صندوق پستی استفاده شده توسط آدرس ایمیل اصلی کاربر استفاده می‌کند. یک نام مستعار کاربر می‌تواند با دامنه حساب کاربری متفاوتی نسبت به دامنه‌ای که توسط آدرس ایمیل اصلی کاربر استفاده می‌شود، مرتبط باشد. ظرف ۲۴ ساعت (اغلب زودتر)، کاربر شروع به دریافت ایمیل‌های ارسال شده به این آدرس می‌کند. 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 را برمی‌گرداند.