إعداد بوابة خدمات المطوّرين لاستخدام SAML للتواصل مع Edge

الإصدار 4.18.01 من Edge for Private Cloud

تعمل بوابة خدمات المطوّرين كعميل لـ Apigee Edge. وهذا يعني أن البوابة لا والعمل كنظام مستقل. بدلاً من ذلك، يتم فعليًا نقل الكثير من المعلومات التي تستخدمها البوابة المخزنة على Edge. عند الضرورة، تقدم البوابة طلبًا لاسترداد المعلومات من Edge أو لإرسال المعلومات إلى Edge.

ترتبط البوابة دائمًا بمؤسسة Edge واحدة. عند تهيئة يمكنك تحديد بيانات اعتماد المصادقة الأساسية (اسم المستخدم وكلمة المرور) في المؤسسة التي تستخدمها البوابة للتواصل مع Edge.

إذا اخترت تفعيل SAML لمصادقة Edge، يمكنك بعد ذلك ضبط البوابة لاستخدام مصادقة SAML عند تقديم طلبات إلى Edge. إعداد البوابة لاستخدام SAML تنشئ تلقائيًا حسابًا جديدًا لمستخدم الجهاز في مؤسسة Edge الذي تعتمده البوابة الشركة لتقديم طلبات إلى Edge. لمزيد من المعلومات حول مستخدمي الأجهزة، يُرجى الاطّلاع على استخدام SAML مع المهام المبرمَجة.

يتطلب دعم SAML للبوابة أن يكون قد تم تثبيت وتهيئة Edge من قبل وحدة تسجيل الدخول الأحادي على عقدة خادم إدارة Edge. تشير العملية العامة لتفعيل SAML لـ البوابة هي:

  1. اضبط SAML في Edge كما هو موضَّح في مقالة تثبيت SAML وضبطه Edge: ملاحظة: يجب أن تظل المصادقة الأساسية مفعّلة على Edge لتثبيت البوابة. عدم إيقاف المصادقة الأساسية على Edge حتى بعد إعداد البوابة لاستخدامها SAML.
  2. ثبّت البوابة وتأكد من أن عملية التثبيت تعمل بشكل صحيح. راجع تثبيت Edge for Private بوابة خدمات Cloud Developer Services
  3. يمكنك ضبط SAML على البوابة.
  4. يمكنك الآن إيقاف "المصادقة الأساسية" على Edge.

إنشاء مستخدم جهاز للمدخل

عند تفعيل SAML، يدعم Edge الإنشاء التلقائي للرموز المميزة لـ OAuth2 من خلال استخدام مستخدمي الأجهزة. يمكن لمستخدم الجهاز الحصول على رموز OAuth2 المميزة بدون الحاجة إلى تحديد رمز المرور. هذا يعني أنه يمكنك أتمتة عملية الحصول على OAuth2 وتحديثه بشكل تلقائي الرموز المميزة.

تؤدي عملية ضبط SAML للبوابة إلى إنشاء مستخدم جهاز تلقائيًا من خلال المؤسسة المرتبطة بالبوابة. تستخدم البوابة بعد ذلك حساب مستخدم الجهاز هذا للاتصال بـ Edge. لمزيد من المعلومات حول مستخدمي الأجهزة، يمكنك مراجعة استخدام SAML مع المهام المبرمَجة

لمحة عن المصادقة لمطوّر برامج البوابة حسابات

عند ضبط البوابة لاستخدام SAML، يمكنك تفعيل البوابة من استخدام SAML للمصادقة مع Edge كي تتمكّن البوابة من تقديم طلبات إلى Edge. ومع ذلك، تتيح البوابة أيضًا نوعًا للمستخدم اسم المطوّرين.

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

عندما يسجِّل مطوِّر برامج الدخول إلى البوابة، تكون البوابة هي المسؤولة عن ومصادقة المطوّر وفرض الأذونات المستندة إلى الدور. ستستمر البوابة استخدام المصادقة الأساسية مع المطوّرين حتى بعد تفعيل SAML بين البوابة وEdge. لمزيد من المعلومات، يمكنك الاطلاع على تواصل بين البوابة وEdge.

ومن الممكن أيضًا ضبط البوابة لاستخدام SAML لمصادقة المطوّرين. بالنسبة إلى على تفعيل SAML باستخدام وحدات Drupal التابعة لجهات خارجية، راجِع https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-portal.html.

ضبط SAML على البوابة من أجل التواصل مع Edge

لضبط SAML للبوابة، عليك إنشاء ملف إعداد لضبط البوابة:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

لتفعيل دعم SAML على البوابة:

  1. في واجهة مستخدم Edge، أضِف مستخدم الجهاز الذي حدّده DEVPORTAL_ADMIN_EMAIL إلى المؤسسة. المرتبطة بالبوابة بصفتك مشرف مؤسسة.
    ملاحظة: حساب مستخدم الجهاز غير متوفّر بعد، ولكن يتم إنشاؤه تلقائيًا في الخطوة التالية.
  2. نفِّذ الأمر التالي لضبط SAML على البوابة:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal Configuration-sso -f samlConfigFile

    حيث يكون samlConfigFile هو ملف إعداد SAML.
  3. سجِّل الدخول إلى البوابة كمشرف للبوابة.
  4. في قائمة Drupal الرئيسية، اختَر Configuration > بوابة مطوّري البرامج البوابة ستظهر شاشة الضبط، بما في ذلك إعدادات SAML:

    يُرجى ملاحظة أن مربع هذه المؤسسة تم تفعيل SAML بها تم التحقق منه، فسيتم ملء نقطة النهاية لوحدة الدخول الموحّد (SSO) على Edge، ومفتاح واجهة برمجة التطبيقات ملء حقول سر المستهلك لبرنامج Oauth للبوابة تظهر الرسالة تم الاتصال بنجاح ضمن علامة التبويب اختبار زر "اتصال".

  5. يمكنك الضغط على الزر اختبار الاتصال لإعادة اختبار الاتصال في في أي وقت.

لتغيير هذه القيم لاحقًا، عدِّل ملف الإعداد وشغِّل الأمر مرة أخرى.

إيقاف SAML على البوابة

إذا اخترت إيقاف SAML للاتصالات بين البوابة وEdge، ستتخذ البوابة من إرسال طلبات إلى Edge بعد الآن. يمكن للمطوّرين تسجيل الدخول إلى البوابة، ولكن يمكنهم لن يتمكنوا من عرض المنتج أو إنشاء التطبيقات.

تحذير: في حال إيقاف SAML، يجب إعادة ضبطها للبوابة من أجل إما استخدام SAML، أو إذا كانت Edge لا تزال مضبوطة على "المصادقة الأساسية"، عليك ضبط البوابة التواصل مع Edge باستخدام المصادقة الأساسية. لمزيد من المعلومات حول استخدام المصادقة الأساسية، راجع التواصل بين البوابة وEdge.

لإيقاف SAML على البوابة:

  1. عدِّل ملف الإعداد الذي استخدمته لضبط ميزة SAM لضبط ما يلي:
    DEVPORTAL_SSO_ENABLED=n
  2. ضبط البوابة:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal Configuration-sso -f configFile