استفاده از apigee-ssoadminapi.sh

واحد Apigee SSO از دو نوع حساب پشتیبانی می‌کند:

ابزار apigee-ssoadminapi.sh به شما امکان می‌دهد حساب‌های کاربری سرپرست و ماشین را که با ماژول Apigee SSO مرتبط هستند مدیریت کنید.

از ابزار apigee-ssoadminapi.sh برای کارهای زیر استفاده کنید:

  • مشاهده فهرست کاربران سرپرست/ماشین
  • افزودن یا حذف کاربران سرپرست/ماشین
  • تغییر گذرواژه کاربران سرپرست/دستگاه

درباره کاربران سرپرست

برای مدیریت ویژگی‌های واحد Apigee SSO، به حساب سرپرست در این واحد نیاز است.

به‌طور پیش‌فرض، وقتی ماژول Apigee SSO را نصب می‌کنید، حساب سرپرستی با اعتبارنامه زیر ایجاد می‌کند:

  • نام کاربری: توسط ویژگی SSO_ADMIN_NAME در فایل پیکربندی مورداستفاده برای پیکربندی کردن ماژول Apigee SSO تعریف می‌شود. پیش‌فرض ssoadmin. است
  • گذرواژه: توسط ویژگی SSO_ADMIN_SECRET در فایل پیکربندی استفاده‌شده برای پیکربندی کردن واحد Apigee SSO تعریف شده است.

درباره کاربران ماشینی

کاربر ماشین می‌تواند بدون نیاز به مشخص کردن گذرنویسه، کدهای OAuth2 را دریافت کند. این یعنی شما می‌توانید فرایند دریافت و بازآوری کردن توکن‌های OAuth2 را بااستفاده از Edge management API کاملاً خودکار کنید.

معمولاً از کاربران ماشینی برای این موارد استفاده می‌کنید:

  • پیکربندی درگاه Apigee Developer Services (یا به‌طور خلاصه، درگاه) برای برقراری ارتباط با Edge
  • وقتی محیط توسعه نرم‌افزار از خودکارسازی برای تکالیف توسعه رایج، مثل خودکارسازی آزمایش یا CI/CD، پشتیبانی می‌کند.

برای اطلاعات بیشتر، به خودکارسازی کردن تکالیف برای ارائه‌دهندگان هویت خارجی مراجعه کنید.

درحال نصب apigee-ssoadminapi.sh

برنامه کمکی apigee-ssoadminapi.sh را در گره Edge Management Server که واحد Apigee SSO را در آن نصب کرده‌اید نصب کنید. معمولاً وقتی ماژول Apigee SSO را نصب می‌کنید، ابزار کمکی apigee-ssoadminapi.sh را نصب می‌کنید.

اگر هنوز ابزارک apigee-ssoadminapi.sh را نصب نکرده‌اید:

  1. به گره Management Server وارد شوید. آن گره باید ازقبل apigee-service را نصب کرده باشد، همان‌طور که در نصب ابزار کمکی apigee-setup در Edge شرح داده شده است.
  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 از مقادیر پیش‌فرض ۹۰۹۹ برای --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