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

الإصدار 4.18.01 من Edge الخاص بخدمة Private Cloud

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

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

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

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

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

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

استخدِم الأداة apigee-adminapi.sh لتنفيذ مهام إعداد Edge نفسها التي تنفّذها من خلال إجراء استدعاءات لواجهة Edge Management API. تتمثل ميزة 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 لوحدة الدخول الموحَّد في 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 رمز المرور.
  • يحدِّد 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 المستخدمة لإنشاء مؤسسات وبيئات ومضيفين افتراضيين
  • يتم استخدام 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 لوحدة تسجيل الدخول الموحَّد (SSO) في Edge. عدِّل المنفذ أو البروتوكول في حال تغييرهما من 9099 وHTTP.
  • يحدِّد OAUTH_FLOW إمّا passcode أو password_grant. في هذا المثال، تحدّد password_grant لأنّك تمرِّر كلمة مرور مشرف النظام.
  • يحدد OAUTH_ADMIN_PASSWORD كلمة مرور مشرف النظام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 إما رمز المرور أو password_grant، وذلك بناءً على الطريقة التي حصلت بها على الرمز في الأساس. في هذا المثال، يمكنك تحديد رمز المرور لأنك حصلت في الأصل على الرمز المميّز باستخدام get_token. يُرجى الاطّلاع على استخدام SAML مع واجهة برمجة تطبيقات إدارة Edge.
  • يحتوي OAUTH_BEARER_TOKEN على الرمز المميّز.