استخدام apigee-ssoapi.sh

تتوافق وحدة الدخول الموحّد لخدمة Apigee مع نوعين من الحسابات:

تتيح لك الأداة apigee-ssoadminapi.sh إدارة حسابات المشرفين ومستخدمي الأجهزة المرتبطة بوحدة Apigee للدخول الموحّد (SSO).

يمكنك استخدام الأداة المساعدة apigee-ssoadminapi.sh لإجراء ما يلي:

  • عرض قائمة مستخدمي المشرف/الجهاز
  • إضافة مستخدمي المشرف/الجهاز أو حذفهم
  • تغيير كلمة المرور لمشرفي/مستخدمي الجهاز

لمحة عن المستخدمين المشرفين

يجب توفّر حساب مشرف في وحدة الدخول الموحّد Apigee لإدارة خصائص الوحدة.

عند تثبيت وحدة Apigee لخدمة الدخول المُوحَّد (SSO)، يتم تلقائيًا إنشاء حساب مشرف باستخدام بيانات الاعتماد التالية:

  • اسم المستخدم: يتم تحديده من خلال السمة SSO_ADMIN_NAME في ملف الإعداد المستخدَم لضبط وحدة الدخول الموحّد في Apigee. القيمة التلقائية هي ssoadmin..
  • كلمة المرور: يتم تحديدها من خلال السمة SSO_ADMIN_SECRET في ملف الإعداد المستخدَم لضبط وحدة الدخول الموحّد Apigee.

لمحة عن مستخدمي الأجهزة

يمكن لمستخدم الجهاز الحصول على رموز OAuth2 المميزة بدون الحاجة إلى تحديد رمز مرور. وهذا يعني أنّه يمكنك برمجة عملية الحصول على رموز OAuth2 المميزة وإعادة تحميلها باستخدام واجهة برمجة تطبيقات Edge Management API.

وعادةً ما تستخدم مستخدمي الأجهزة لإجراء ما يلي:

  • ضبط بوابة خدمات مطوّري Apigee (أو البوابة) للتواصل مع Edge
  • عندما تتيح بيئة التطوير التشغيل الآلي لمهام التطوير الشائعة، مثل التشغيل الآلي للاختبار أو CI/CD

لمزيد من المعلومات، يُرجى الاطّلاع على برمجة المهام لموفِّري الهوية الخارجيين.

تثبيت apigee-ssoadminapi.sh

ثبِّت الأداة المساعدة apigee-ssoadminapi.sh على عقدة Edge Management Server حيث تم تثبيت وحدة الدخول الموحّد (SSO) Apigee. ويتم عادةً تثبيت الأداة apigee-ssoadminapi.sh عند تثبيت وحدة Apigee لخدمة الدخول المُوحَّد (SSO).

في حال عدم تثبيت الأداة apigee-ssoadminapi.sh بعد:

  1. سجّل الدخول إلى عقدة خادم الإدارة. يجب أن تكون هذه العقدة apigee-service مثبَّتة على النحو الموضَّح في تثبيت الأداة المساعدة Edge apigee-setup.
  2. ثبِّت أداة apigee-ssoadminapi.sh المستخدَمة لإدارة مستخدمي المشرفين والمستخدمين لوحدة الدخول الموحّد Apigee من خلال تنفيذ الأمر التالي: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. سجِّل الخروج من واجهة الأوامر، ثم أعِد تسجيل الدخول لإضافة الأداة المساعدة apigee-ssoadminapi.sh إلى مسارك.

عرض معلومات المساعدة بخصوص apigee-ssoadminapi.sh

الأوامر المتاحة للأداة هي:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add (استخدِم الأمر saml لجميع موفِّري الهوية (idP)، بما في ذلك LDAP وSAML)
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

ويمكنك الاطّلاع على معلومات عن هذه الأوامر في ملف /opt/apigee/apigee-ssoadminapi/README.md. بالإضافة إلى ذلك، يمكنك تحديد الخيار " -h" لكل أمر لعرض معلومات الاستخدام.

على سبيل المثال، الأمر التالي:

apigee-ssoadminapi.sh admin list -h

المرتجعات:

admin list
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

استدعاء الأداة المساعدة apigee-ssoadminapi.sh

يمكنك استدعاء أداة apigee-ssoadminapi.sh من خلال تمرير جميع الخصائص كوسيطات سطر الأوامر أو في الوضع التفاعلي من خلال الاستجابة للمطالبات.

على سبيل المثال، لتحديد جميع المعلومات المطلوبة في سطر الأوامر للاطّلاع على قائمة المستخدمين المشرفين:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

المرتجعات:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

في حال حذف أي معلومات مطلوبة، مثل كلمة مرور المشرف، سيُطلب منك ذلك.

في هذا المثال، سيتم حذف قيمتَي --port و--ssl لأنّ وحدة Apigee لخدمة الدخول المُوحَّد (SSO) تستخدم القيم التلقائية 9099 للسمة --port وhttp في --ssl. إذا كانت عملية التثبيت لا تستخدم هذه الإعدادات التلقائية، حدِّدها:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123
  --host 35.197.94.184 --port 9443 --ssl https

يمكنك بدلاً من ذلك استخدام النموذج التفاعلي الذي يُطلب منك فيه جميع المعلومات:

apigee-ssoadminapi.sh admin list

سيُطلب منك بعد ذلك تقديم جميع المعلومات المطلوبة:

SSO admin name (current): ssoadmin
SSO Admin secret (current):
SSO host: 35.197.94.184