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

Edge for Private Cloud نسخه ۴.۱۷.۰۹

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

• سرپرست
• کاربر ماشین

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

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

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

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

برای مدیریت ویژگی‌های واحد Edge SSO، به حساب سرپرست در این واحد نیاز است. همچنین برای پیکربندی API BaaS یا درگاه برای اتصال به ماژول، به اعتبارنامه‌های حساب سرپرست نیاز دارید.

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

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

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

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

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

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

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

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

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

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

1. به گره Management Server وارد شوید. آن گره باید ازقبل apigee-service را نصب کرده باشد، همان‌طور که در نصب ابزار کمکی Edge apigee-setup شرح داده شده است.
2. ابزار apigee-ssoadminapi.sh را که برای مدیریت کاربران سرپرست و ماشین برای ماژول
   Edge SSO استفاده می‌شود نصب کنید: > /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
3. از پوسته خارج شوید و سپس دوباره به سیستم وارد شوید تا ابزار کمکی apigee-ssoadminapi.sh به مسیر شما اضافه شود.

مشاهده اطلاعات راهنما برای apigee-ssoadminapi.sh

فرمان‌های دردسترس برای این ابزار عبارت‌اند از:

• افزودن سرپرست
• حذف سرپرست
• فهرست سرپرست
• 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 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