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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. به سیستم گره «سرور مدیریت» وارد شوید. آن گره باید ازقبل apigee-service را همان‌طور که در نصب ابزار کمکی apigee-setup در Edge توضیح داده شده است نصب کرده باشد.
  2. با اجرای فرمان زیر، ابزار apigee-ssoadminapi.sh را که برای مدیریت کاربران سرپرست و ماشین برای واحد Apigee SSO استفاده می‌شود نصب کنید: 
    /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 را حذف می‌کنید زیرا واحد 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