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

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

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

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

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

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

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

استخدام أداة 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، بناءً على كيفية حصولك على الرمز المميّز في الأصل. في هذا المثال، يمكنك تحديد رمز المرور لأنّك حصلت في الأصل على الرمز المميّز باستخدام get_token. يُرجى الاطّلاع على استخدام SAML مع واجهة برمجة التطبيقات لإدارة Edge.
  • يحتوي oauh_token على الرمز المميّز.

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

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

  • apigee-provision used to create organizations, environments, and virtual hosts
  • 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 تحدّد passcode.
  • 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، وذلك حسب طريقة حصولك على الرمز المميّز في الأصل. في هذا المثال، يمكنك تحديد رمز المرور لأنّك حصلت في الأصل على الرمز المميّز باستخدام get_token. يُرجى الاطّلاع على استخدام SAML مع واجهة برمجة التطبيقات لإدارة Edge.
  • يحتوي OAUTH_BEARER_TOKEN على الرمز المميّز.