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

الإصدار 4.18.05 من Edge for Private Cloud

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

  • مسؤول الإدارة
  • مستخدم جهاز

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

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

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

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

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

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

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

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

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

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

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

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

تثبيت apigee-ssoadminapi.sh

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

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

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