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

Edge for Private Cloud ‏v4.18.01

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

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

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