واجهة برمجة تطبيقات الدليل: الأسماء المستعارة للمستخدم

إنشاء اسم مستعار للمستخدم

عنوان البريد الإلكتروني البديل للمستخدم هو عنوان بريد إلكتروني بديل يستخدم صندوق البريد الإلكتروني نفسه الذي يستخدمه عنوان البريد الإلكتروني الرئيسي للمستخدم. ويمكن ربط اسم مستخدم مستعار بنطاق حساب مختلف عن النطاق المستخدم في عنوان البريد الإلكتروني الرئيسي للمستخدم. في غضون 24 ساعة (غالبًا في وقت أقرب من ذلك)، يبدأ المستخدم باستلام رسائل البريد الإلكتروني المرسلة إلى هذا العنوان. وتتطلب واجهة برمجة التطبيقات تأكيد ملكية النطاق قبل أن تتمكن من إنشاء اسم مستعار للمستخدم.

لإنشاء اسم مستعار للمستخدم، استخدم طلب POST التالي وأدرِج التفويض الموضح في طلبات التفويض. يمكن أن يكون userKey هو عنوان البريد الإلكتروني الرئيسي للمستخدم أو المستخدم id أو أي من عناوين البريد الإلكتروني البديلة للمستخدم. بالنسبة إلى خصائص الطلب والاستجابة، راجع مرجع واجهة برمجة التطبيقات:

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 أو أي من عناوين البريد الإلكتروني البديلة للمستخدم. بالنسبة إلى خصائص الطلب والاستجابة، راجع مرجع واجهة برمجة التطبيقات:

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 هو عنوان البريد الإلكتروني البديل الذي يتم حذفه. بالنسبة إلى خصائص الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
على سبيل المثال، يؤدي طلب DELETE هذا إلى حذف العنوان البديل Chica@example.com لمفتاح المستخدم، liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

تعرض الاستجابة الناجحة رمز حالة HTTP 200.