نظرة عامة على Admin Settings API

تسمح واجهة برمجة التطبيقات لإعدادات المشرف لمشرفي نطاقات Google Workspace باسترداد إعدادات نطاقاتهم وتغييرها في شكل خلاصات Google Data API.

وتتضمّن إعدادات النطاق هذه العديد من الميزات المتوفّرة في وحدة تحكُّم مشرف Google Workspace. ومن أمثلة استخدامات واجهة برمجة التطبيقات هذه إنشاء لوحة تحكُّم مخصَّصة أو دمج نطاقات Google Workspace في بيئة قديمة حالية.

تنفّذ واجهة Admin Settings API بروتوكول Google Data API. تتوافق واجهة برمجة التطبيقات لبيانات Google مع نموذج النشر والتعديل لبروتوكول Atom Publishing. تستخدم طلبات AtomPub HTTP أسلوب تصميم Representational Set Transfer (RESTful) لخدمات الويب. للحصول على مزيد من المعلومات، يُرجى الاطّلاع على دليل مطوّري بيانات Google.

الجمهور

هذا المستند مخصَّص للمطوّرين الذين يريدون كتابة تطبيقات العميل التي يمكنها تعديل معلومات عن نطاقات Google Workspace واستردادها. ويقدّم هذا التقرير أمثلة على تفاعلات واجهة برمجة التطبيقات Admin Settings API الأساسية باستخدام ملف XML وHTTP الأوليَين.

يفترض هذا المستند أنّك تفهم الأفكار العامة التي تستند إليها بروتوكول Google Data API، وأنّك على دراية بـ "وحدة تحكّم مشرف Google Workspace". للحصول على مزيد من المعلومات حول "وحدة تحكُّم المشرف"، يُرجى الاطّلاع على استخدام "وحدة تحكُّم المشرف".

البدء

إنشاء حساب

يتم تفعيل واجهة Admin Settings API لحسابات Google Workspace. اشترِك للحصول على حساب Google Workspace لأغراض الاختبار. تستخدم خدمة "إعدادات المشرف" حسابات Google، وبالتالي إذا كان لديك حساب على نطاق Google Workspace، ليس عليك اتّخاذ أي إجراء.

ملاحظة: يمكنك ضبط إعدادات نطاقك باستخدام واجهة برمجة تطبيقات الإعدادات للمشرف واستخدام واجهة برمجة تطبيقات إعدادات البريد الإلكتروني لضبط إعدادات إعدادات البريد الإلكتروني.

لمحة عن أنواع خلاصات Admin Settings API

تتيح لك واجهة برمجة التطبيقات Admin Settings API إدارة الفئات التالية من إعدادات النطاق:

إعدادات الدخول الموحَّد

يسمح الدخول المُوحَّد (SSO) المستنِد إلى SAML للمستخدمين باستخدام معلومات تسجيل الدخول وكلمة المرور نفسيهما لكل من خدمات Google Workspace المستضافة، بالإضافة إلى الخدمات الأخرى التي قد تستضيفها داخل مؤسستك. على وجه التحديد، عند استخدام خدمة الدخول المُوحَّد (SSO)، يعمل تطبيق ويب مستضاف، مثل Google Workspace، على إعادة توجيه المستخدمين إلى موفِّر هوية مؤسستك لمصادقة المستخدمين عند تسجيلهم الدخول. للحصول على معلومات تفصيلية، يُرجى الاطِّلاع على مقالة التعرّف على خدمة الدخول المُوحَّد (SSO) المستنِدة إلى SAML لخدمة Google Workspace.

تشمل عملية إعداد خدمة الدخول المُوحَّد (SSO) إدخال المعلومات اللازمة لخدمة Google Workspace للتواصل مع موفِّر الهوية الذي يخزِّن بيانات المستخدمين. معلومات تسجيل الدخول، بالإضافة إلى إعداد الروابط التي يجب أن ينتقل المستخدمون إليها لتسجيل الدخول، وتسجيل الخروج، وتغيير كلمات المرور. تسمح لك واجهة برمجة تطبيقات إعدادات المشرف بتعديل هذه الإعدادات واستردادها آليًا. تستخدم Google المفتاح العام الذي تم إنشاؤه للتحقّق من طلب الدخول المُوحَّد (SSO) هذا من خلال موفِّر الهوية وأنّه لم يتم تعديل استجابة SAML للمفتاح الخاص أثناء نقل الشبكة.

للحصول على ملخّص قصير ومحدد لواجهة برمجة التطبيقات عن استخدام إعدادات الدخول المُوحَّد (SSO)، احصل على شهادة المفتاح العام من موفِّر الهوية، وسجِّل المفتاح العام في Google، ثم اضبط إعدادات طلبات الدخول المُوحَّد (SSO) المستندة إلى SAML. لمعرفة رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

• إنشاء مفاتيحك -- باستخدام موفر الهوية، يمكنك إنشاء مجموعة من المفاتيح العامة والخاصة باستخدام خوارزميات DSA أو RSA. يتضمن المفتاح العام شهادة بتنسيق X.509. لمزيد من المعلومات عن مفاتيح تسجيل الدخول الموحَّد المستنِدة إلى SAML، يمكنك الاطّلاع على إنشاء المفاتيح والشهادات لخدمة الدخول الموحَّد في Google Workspace.
• التسجيل في Google -- استخدِم إعدادات الدخول الموحَّد في واجهة برمجة تطبيقات المشرف لتسجيل شهادة المفتاح العام الخاصة بك لدى Google.
• ضبط إعدادات الدخول المُوحَّد (SSO) -- استخدم إعدادات الدخول الموحَّد في واجهة برمجة تطبيقات المشرف لضبط الإعدادات المستخدمة للاتصال بخوادم موفِّر هوية النطاق.

ملاحظة: بالنسبة إلى البروتوكولات التي لا تستخدم تدفق تسجيل الدخول المستنِد إلى الويب، مثل بعض برامج البريد الإلكتروني عبر بروتوكول POP/IMAP، يسجِّل المستخدمون الدخول مباشرةً باستخدام اسم المستخدم وكلمة المرور على Google Workspace.

إعدادات المدخل والتوجيه

تتيح هذه الخلاصة لمشرفي النطاقات التحكّم في توجيه البريد الإلكتروني لنطاقاتهم.

تتيح عمليات توجيه البريد الإلكتروني للمشرفين تحديد إعدادات توجيه البريد الإلكتروني على مستوى النطاق. يشبه ذلك وظيفة توجيه البريد الإلكتروني ضمن إعدادات Gmail في وحدة تحكُّم المشرف. للمزيد من المعلومات، يُرجى الاطّلاع على توجيه البريد الإلكتروني وضبط التسليم الثنائي لميزة توجيه البريد الإلكتروني.

نموذج لطلب وردّ بتنسيق XML لواجهة برمجة التطبيقات الخاصة بـ Admin Settings API

يعرض هذا المستند أمثلة لرموز برمجية لطلبات واستجابات واجهة برمجة التطبيقات لإعدادات المشرف الأساسية باستخدام XML وHTTP الأوليَين. يعرض مثال اللغة التلقائية للنطاق هذا بنية XML وHTTP الكاملة للنص الأساسي لإدخال الطلب والاستجابة وهو أمر شائع في كل عملية:

لتغيير إعداد مدخل البريد الإلكتروني الصادر للنطاق، أرسِل PUT HTTP إلى عنوان URL لخلاصة المدخل:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

لغة النطاق التلقائية PUT لطلب AtomPub entry XML هي:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

باستثناء السمات والقيم الخاصة بالعملية، تمثّل عناصر atom:property زوجًا واحدًا من المفتاح/القيمة يحتوي على معلومات حول السمة التي تريد استردادها أو تعديلها. تُعد هذه شائعة بين جميع نصوص طلبات واجهة برمجة التطبيقات لإعدادات المشرف.

يعرض عنصر استجابة اللغة التلقائية للنطاق entry السمتَين smartHost وsmtpMode بالإضافة إلى بنية XML الشائعة لجميع نصوص الرد الخاصة بواجهة برمجة التطبيقات لإعدادات المشرف:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

إدارة إعدادات الدخول الموحّد

تتيح ميزة "الدخول المُوحَّد" (SSO) في Google Workspace للمستخدمين تسجيل الدخول إلى خدمات متعدّدة بدون الحاجة إلى إدخال معلومات تسجيل الدخول وكلمة المرور سوى مرة واحدة. يخزّن موفّر هوية النطاق كلمة المرور هذه، وليس من خلال Google Workspace. للمزيد من المعلومات، راجع صفحة الدخول المُوحَّد (SSO) في مركز المساعدة. توضح الأقسام التالية تنسيق XML المستخدم لإعدادات الدخول الموحّد.

جارٍ استرداد إعدادات تسجيل الدخول الأحادي

لاسترداد إعدادات الدخول الموحّد، أرسِل GET HTTP إلى عنوان URL للخلاصة العامة للدخول المُوحَّد (SSO)، وضمِّن رأس Authorization كما هو موضَّح في مقالة المصادقة على خدمة "إعدادات المشرف". وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

لا تتضمن هذه العملية أي معلمات في نص الطلب.

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub مع إعدادات الدخول المُوحَّد (SSO) للنطاق.

يعرض ملف XML الخاص باستجابة GET السمات samlSignonUri وsamlLogoutUri وchangePasswordUri وenableSSO وssoWhitelist وuseDomainSpecificIssuer:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

وتشمل السمات ما يلي:

samlSignonUri

عنوان URL لموفِّر الهوية الذي يُرسل Google Workspace فيه طلب SAML لمصادقة المستخدم.

samlLogoutUri

العنوان الذي سيتم إرسال المستخدمين إليه عند تسجيل الخروج من تطبيق الويب.

changePasswordUri

العنوان الذي سيتم توجيه المستخدمين إليه عندما يريدون تغيير كلمة مرور الدخول المُوحَّد (SSO) لتطبيق الويب.

enableSSO

يفعِّل هذا الإعداد خدمة الدخول المُوحَّد (SSO) المستند إلى SAML لهذا النطاق. إذا سبق لك ضبط إعدادات الدخول المُوحَّد (SSO)، ثم ضبطت enableSSO على enableSSO=false بعد ذلك، ستظل الإعدادات التي أدخلتها سابقًا محفوظة.

ssoWhitelist

قائمة الدخول المُوحَّد (SSO) البيضاء هي عنوان IP لقناع الشبكة بتنسيق "التوجيه غير الفئوي بين النطاقات" (CIDR). تحدِّد القائمة البيضاء (SSO) المستخدمين الذين يسجّلون الدخول باستخدام خدمة الدخول المُوحَّد (SSO) والمستخدمين الذين يسجِّلون الدخول باستخدام صفحة مصادقة حساب Google Workspace. إذا لم يتم تحديد أي أقنعة، فسيقوم جميع المستخدمين بتسجيل الدخول باستخدام خدمة الدخول المُوحَّد (SSO). لمزيد من المعلومات، يُرجى الاطّلاع على آلية عمل أقنعة الشبكات.

useDomainSpecificIssuer

يمكن استخدام جهة إصدار خاصة بالنطاق في طلب SAML لموفِّر الهوية. وتعد هذه الميزة مفيدة في الشركات الكبيرة التي تستخدم موفّر هوية واحدًا لمصادقة المؤسسة بأكملها من خلال عدة نطاقات فرعية، على الرغم من أنها ليست ضرورية لمعظم عمليات نشر خدمة الدخول المُوحَّد (SSO). ويؤدي منح جهة إصدار النطاق المحدّدة إلى تحديد النطاق الفرعي المطلوب ربطه بالطلب. لمزيد من المعلومات، يُرجى الاطِّلاع على كيف يعمل عنصر "جهة الإصدار" في طلب SAML؟

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

تحديث إعدادات الدخول الموحّد

لتحديث إعدادات تسجيل الدخول الأحادي للنطاق، يمكنك أولاً استرداد إعدادات تسجيل الدخول الأحادي باستخدام عملية استرداد إعدادات الدخول الموحّد، ثم تعديل الإعدادات، ثم إرسال طلب PUT إلى عنوان URL لخلاصة الدخول الموحّد. تأكَّد من أنّ قيمة <id> في الإدخال المعدّل تتطابق تمامًا مع <id> للإدخال الحالي. ضمِّن عنوان Authorization كما هو موضَّح في المصادقة على خدمة Admin Settings API. وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها.

عند تعديل إعدادات "الدخول الموحّد"، أرسِل HTTP PUT إلى عنوان URL للخلاصة العامة لخدمة "الدخول الموحّد" (SSO):

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

نص XML الخاص بطلب PUT هو:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub مع إعدادات خدمة الدخول المُوحَّد (SSO).

ملف XML الخاص بالاستجابة PUT هو:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

لا يُسمح بإجراء تغييرات على إعدادات الدخول الموحّد عندما يفعّل العميل المستهدف موافقة جهات متعددة على الإجراءات الحسّاسة. سيتعذّر تنفيذ الطلبات مع errorCode="1811" وreason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

استرداد مفتاح توقيع الدخول الموحّد

لاسترداد مفتاح توقيع الدخول الموحّد، أرسِل GET HTTP إلى عنوان URL لخلاصة مفتاح توقيع الدخول الموحَّد (SSO)، وضمِّن رأس Authorization كما هو موضَّح في مقالة المصادقة على خدمة "إعدادات المشرف". وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

لا تتضمن هذه العملية أي معلمات في نص الطلب.

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub مع مفتاح التوقيع.

يعرض ملف XML الخاص باستجابة GET السمة signingKey:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

تحديث مفتاح توقيع الدخول الموحّد

لتحديث مفتاح توقيع خدمة "الدخول الموحّد" (SSO) للنطاق، يمكنك أولاً استرداد مفتاح التوقيع باستخدام عملية استرداد مفتاح تسجيل الدخول الأحادي، وتعديل المفتاح، ثم إرسال طلب PUT إلى عنوان URL لخلاصة مفتاح توقيع خدمة "الدخول الموحّد". تأكَّد من أنّ قيمة <id> في الإدخال المعدّل تتطابق تمامًا مع <id> للإدخال الحالي. لمزيد من المعلومات عن مفاتيح تسجيل الدخول الموحَّد المستنِدة إلى SAML، يمكنك الاطّلاع على إنشاء المفاتيح والشهادات لخدمة الدخول الموحَّد في Google Workspace.

عند تعديل مفتاح توقيع الدخول الموحَّد، أرسِل PUT HTTP إلى عنوان URL لخلاصة مفتاح توقيع الدخول الموحَّد (SSO):

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

ملف XML الخاص بطلب PUT هو:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

ملاحظة: يجب استخدام السمة signingKey لهذا الطلب.

لا يُسمح بإجراء تغييرات على إعدادات الدخول الموحّد عندما يفعّل العميل المستهدف موافقة جهات متعددة على الإجراءات الحسّاسة. سيتعذّر تنفيذ الطلبات مع errorCode="1811" وreason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

إدارة مدخل البريد الإلكتروني وتوجيهه

يوضح قسم مدخل البريد الإلكتروني الصادر كيف تدعم واجهة برمجة تطبيقات إعدادات المشرف توجيه البريد الصادر من المستخدمين في نطاقك. يعرض قسم توجيه البريد الإلكتروني كيفية توجيه الرسائل إلى خادم بريد آخر.

جارٍ استرداد إعدادات مدخل البريد الإلكتروني الصادر

لاسترداد إعدادات مدخل البريد الإلكتروني الصادر، أرسِل GET HTTP إلى عنوان URL لخلاصة المدخل، وضمِّن رأس Authorization كما هو موضح في المصادقة على خدمة إعدادات المشرف:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

لا تتضمن هذه العملية أي معلمات في نص الطلب.

ملاحظة: يجب أن يكون لديك إصدار مؤهَّل من Google Workspace لاستخدام ميزة مدخل البريد الصادر في Google Workspace.

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub وبها معلومات حالة مدخل البريد الإلكتروني.

تعرض الاستجابة GET السمتَين smartHost وsmtpMode. لمزيد من المعلومات حول هذه السمات، يُرجى الاطّلاع على مقالة تعديل إعدادات مدخل البريد الإلكتروني الصادر.

مثال على رد محتمل:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

تحديث إعدادات مدخل البريد الإلكتروني الصادر

لتعديل إعداد مدخل البريد الإلكتروني الصادر لنطاق، أرسِل طلب HTTP PUT إلى عنوان URL لخلاصة المدخل:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

ملاحظة: يجب أن يكون لديك إصدار مؤهَّل من Google Workspace لاستخدام ميزة مدخل البريد الصادر في Google Workspace.

ملف XML الخاص بطلب PUT هو:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

خصائص الطلب هي:

smartHost

عنوان IP أو اسم المضيف لخادم SMTP توجّه Google Workspace البريد الصادر إلى هذا الخادم.

smtpMode

القيمة التلقائية هي SMTP. تؤمّن قيمة أخرى، وهي SMTP_TLS، الاتصال باستخدام بروتوكول أمان طبقة النقل (TLS) عند تسليم الرسالة.

ملاحظة: اتّبِع تعليمات وكيل نقل البريد لإعداد الرسائل الإلكترونية المُرسَلة من Google Workspace.

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub مع حالة إعدادات مدخل البريد الإلكتروني.

ملاحظة: أرسِل رسالة إلكترونية من Google Workspace إلى مستخدم خارج نطاقك للتحقّق من عمل البريد الصادر المُرسَل من خلال المدخل بعد إجراء التغييرات.

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

إدارة إعدادات توجيه البريد الإلكتروني

أولاً، أنشئ طلب XML:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

خصائص الطلب هي:

routeDestination

هذه الوجهة هي اسم المضيف أو عنوان IP لخادم بريد SMTP-In الذي يتم توجيه الرسائل الإلكترونية إليه. يجب أن يتم تحويل اسم المضيف أو عنوان IP إلى Google. لمزيد من التفاصيل حول حل أسماء مضيفي البريد، يُرجى الاطّلاع على الإصدار التجريبي من Google Workspace مع توجيه البريد الإلكتروني.

routeRewriteTo

في حال اختيار القيمة "صحيح"، يتم تغيير الحقل to: لمغلف SMTP للرسالة إلى اسم مضيف الوجهة (اسم مضيف الوجهة user@destination)، ويتم تسليم الرسالة إلى عنوان المستخدم هذا على خادم البريد الوجهة. في حال false، سيتم تسليم الرسالة الإلكترونية إلى عنوان البريد الإلكتروني to: الأصلي للرسالة (user@Original) على خادم البريد الوجهة. ويشبه هذا "تغيير مغلف SMTP" في وحدة تحكم المشرف. الإعداد. لمزيد من المعلومات، يُرجى الاطّلاع على إعدادات النطاق لتوجيه البريد الإلكتروني.

routeEnabled

إذا true، سيتم تفعيل وظيفة توجيه البريد الإلكتروني. أمّا في حال false، فسيتم إيقاف الوظيفة.

bounceNotifications

في حال true، يتم تفعيل Google Workspace لإرسال الإشعارات المرتدة إلى المُرسِل عند تعذُّر التسليم.

accountHandling

يحدِّد هذا الإعداد كيفية تأثر الأنواع المختلفة من المستخدمين في النطاق بتوجيه البريد الإلكتروني:

• allAccounts -- تسليم كل الرسائل الإلكترونية إلى هذه الوجهة.
• provisionedAccounts -- تسليم البريد إلى هذه الوجهة إذا كان المستخدم موجودًا في Google Workspace.
• unknownAccounts -- تسليم البريد إلى هذه الوجهة إذا لم يكن المستخدم موجودًا في Google Workspace. يشبه ذلك "رسالة تسليم البريد الإلكتروني لـ" في وحدة تحكُّم المشرف الإعداد. لمزيد من المعلومات حول المتطلبات الأساسية وكيفية استخدام توجيه البريد، راجع إعدادات النطاق لتوجيه البريد الإلكتروني. ~ لنشر هذا الطلب، أرسِل POST HTTP إلى عنوان URL لخلاصة توجيه الرسائل الإلكترونية، وضمِّن رأس Authorization كما هو موضّح في المصادقة على خدمة "إعدادات المشرف":

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

تؤدي الاستجابة الناجحة إلى عرض رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub مع معلومات الأرشيف.

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. للحصول على مزيد من المعلومات حول رموز حالة Google Data API، يمكنك الاطّلاع على رموز حالة HTTP.

إيقاف نقاط النهاية نهائيًا في 31 تشرين الأول (أكتوبر) 2018

لقد أوقفنا نقاط النهاية التالية نهائيًا كجزء من هذا الإعلان. وقد تم إيقافها نهائيًا في 31 تشرين الأول (أكتوبر) 2018 ولم تعُد متاحة.

• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx