استخدام أدوات مساعدة مشرف Edge وواجهات برمجة التطبيقات بعد تفعيل SAML

Edge for Private Cloud‏ 4.17.09

يوضِّح هذا القسم كيفية تشغيل أدوات وطلبات مشرف نظام Edge بعد تفعيل بروتوكول SAML. تتطلب العديد من المهام على Edge أن تكون بيانات اعتماد إدارة النظام، مثل:

  • إنشاء المؤسسات والبيئات
  • إضافة مكوّنات Edge وإزالتها
  • تنفيذ أوامر apigee-adminapi.sh
  • مهام كثيرة أخرى

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

طلب واجهات برمجة تطبيقات إدارة Edge باعتبارها مشرف النظام

تتطلب منك العديد من طلبات البيانات من واجهة برمجة التطبيقات Edge اجتياز بيانات اعتماد مشرف النظام. يحتوي مقالة استخدام SAML مع Edge management API على تعليمات حول كيفية الحصول على الرموز المميّزة وإعادة تحميلها عند إجراء طلبات إلى Edge management API.

استخدام الأداة apigee-adminapi.sh مع مصادقة SAML

استخدِم الأداة apigee-adminapi.sh لتنفيذ مهام ضبط Edge نفسها التي تنفّذها من خلال إجراء طلبات إلى واجهة برمجة تطبيقات إدارة Edge. تتمثل ميزة الأداة apigee-adminapi.sh في أنّها:

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

لمزيد من المعلومات، يُرجى الاطّلاع على استخدام apigee-ssoadminapi.sh.

بعد تفعيل مصادقة SAML، تتوفّر لك عدة طرق لتمرير بيانات اعتماد مشرف النظام إلى الأداة apigee-adminapi.sh.

يمكنك الاطّلاع على جميع خيارات أيّ أمر apigee-adminapi.sh، بما في ذلك خيارات تحديد بيانات اعتماد SAML، باستخدام الخيار "-h" مع الأمر. على سبيل المثال:

> apigee-adminapi.sh orgs list -h

على سبيل المثال، يمكنك تمرير بيانات اعتماد مشرف النظام:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant --admin adminEmail --oauth-password adminPword

حيث:

  • يحدّد sso-url عنوان URL لوحدة الدخول الموحّد (SSO) على Edge. عدِّل المنفذ أو البروتوكول إذا غيّرتهما من 9099 و HTTP.
  • تحدِّد سمة oauth-flow أيًّا مما يلي: passcode أو password_grant. في هذا المثال، عليك تحديد password_grant.
  • adminEmail هو عنوان البريد الإلكتروني لمشرف النظام.
  • تحدِّد oauth-password كلمة مرور مشرف النظام.

بدلاً من ذلك، يمكنك استخدام رمز مرور عند طلب الأمر:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-passcode passcode

حيث:

  • يحدِّد oauth-flow passcode.
  • يحدّد oauth-passcode رمز المرور الذي تم الحصول عليه من http://edge_sso_IP_DNS:9099/passcode.

وأخيرًا، يمكنك استخدام رمز مميز عند استدعاء الأمر:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-token token

حيث:

  • يحدّد oauth-flow إما passcode أو password_grant، استنادًا إلى كيفية الحصول على الرمز المميّز في الأصل. في هذا المثال، يمكنك تحديد passcode لأنّك حصلت في الأصل على رمز المرور باستخدام get_token. اطّلِع على استخدام SAML مع واجهة برمجة تطبيقات إدارة Edge.
  • يحتوي oauh_token على رمز مميّز.

استخدام أدوات Edge مع مصادقة SAML

تتطلّب العديد من أدوات Edge بيانات اعتماد مشرف النظام، مثل:

  • apigee-provision المستخدَم ل إنشاء المؤسسات والبيئات والمضيفين الظاهريين
  • setup.sh المستخدَم لإضافة عقد إلى نظام حالي
  • أي خدمة مساعدة أخرى يجب فيها تحديد بيانات اعتماد مشرف النظام في ملف إعداد

تأخذ هذه الأدوات المساعِدة ملف إعدادات يحدِّد بيانات اعتماد مشرف النظام باستخدام السمات التالية:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

في حال حذف كلمة المرور، سيُطلب منك إدخالها.

بعد تفعيل SAML، يمكنك استخدام سمات مختلفة لتحديد بيانات اعتماد مشرف النظام. على سبيل المثال، يمكنك تمرير بيانات اعتماد مشرف النظام:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

حيث:

  • يحدِّد SSO_LOGIN_URL عنوان URL لمكوّن الدخول المُوحَّد في Edge. عدِّل المنفذ أو البروتوكول إذا غيّرتهما من 9099 و HTTP.
  • يحدِّد OAUTH_FLOW أيًا مما يلي: passcode أو password_grant. في هذا المثال، يمكنك تحديد password_grant لأنّك تدخِل كلمة مرور مشرف النظم.
  • OAUTH_ADMIN_PASSWORD تُحدِّد كلمة مرور مشرف النظام.

بدلاً من ذلك، يمكنك استخدام السمات التالية لتحديد بيانات الاعتماد كجزء من عملية إدخال رمز المرور:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

حيث:

  • يحدِّد OAUTH_FLOW رمز المرور.
  • يحدد OAUTH_ADMIN_PASSCODE رمز المرور الذي تم الحصول عليه من http://edge_sso_IP_DNS:9099/passcode.

أخيرًا، يمكنك استخدام رمز مميّز

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

حيث:

  • يحدِّد OAUTH_FLOW إما passcode أو password_grant، استنادًا إلى كيفية الحصول على الرمز المميّز في الأصل. في هذا المثال، يمكنك تحديد passcode لأنّك حصلت في الأصل على رمز المرور باستخدام get_token. اطّلِع على استخدام SAML مع واجهة برمجة تطبيقات إدارة Edge.
  • يحتوي OAUTH_BEARER_TOKEN على الرمز المميّز.