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

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

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

يمكنك استخدام الأداة apigee-ssoadminapi.sh لتنفيذ ما يلي:

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

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

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

بشكل تلقائي، عند تثبيت وحدة ApigeeSSO، يتم إنشاء حساب مشرف يتضمّن بيانات الاعتماد التالية:

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

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

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

وعادةً ما تستخدم مستخدمي الجهاز في:

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

لمزيد من المعلومات، يُرجى الاطّلاع على تنفيذ المهام تلقائيًا لموفري الهوية الخارجيين (idP).

تثبيت apigee-ssoadminapi.sh

ثبِّت الأداة apigee-ssoadminapi.sh في عقدة Edge Management Server (خادم إدارة Edge) حيث تم تثبيت وحدة ApigeeSSO. يتم عادةً تثبيت الأداة apigee-ssoadminapi.sh عند تثبيت وحدة ApigeeSSO.

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

  1. سجّل الدخول إلى عقدة Management Server. يجب أن تكون هذه العقدة قد تم تثبيت apigee-service عليها مسبقًا كما هو موضَّح في تثبيت الأداة المساعدة لإعداد apigee من Edge.
  2. ثبِّت الأداة apigee-ssoadminapi.sh المستخدمة لإدارة المشرفين ومستخدمي الجهاز لوحدة ApigeeSSO من خلال تنفيذ الأمر التالي: 
    /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