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

تتوافق وحدة الدخول المُوحَّد (SSO) في Apigee مع نوعَين من الحسابات:

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

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

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

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

يجب توفُّر حساب مشرف على وحدة الدخول الموحّد (SSO) في Apigee لإدارة خصائص الوحدة.

By default, when you install the Apigee SSO module, it creates an administrator account with the following credentials:

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

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

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

تُستخدم حسابات المستخدمين الآليين عادةً في ما يلي:

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

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

تثبيت apigee-ssoadminapi.sh

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

إذا لم تكن قد ثبّتّ أداة apigee-ssoadminapi.sh المساعدة بعد:

  1. سجِّل الدخول إلى عقدة خادم الإدارة. يجب أن تكون الأداة المساعدة apigee-service مثبّتة على هذه العقدة كما هو موضّح في تثبيت الأداة المساعدة apigee-setup في Edge.
  2. ثبِّت الأداة المساعدة apigee-ssoadminapi.sh المستخدَمة لإدارة مستخدمي المشرف والجهاز لوحدة الدخول الموحّد (SSO) في 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 لجميع موفّري الهوية، بما في ذلك 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 لأنّ وحدة الدخول المُوحَّد (SSO) في Apigee تستخدم القيم التلقائية 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