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

Edge for Private Cloud نسخه 4.19.01

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

  • مدیر
  • کاربر ماشین (فقط SAML)

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

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

  • لیست کاربران مدیر/ماشین را مشاهده کنید
  • کاربران ادمین/ماشین را اضافه یا حذف کنید
  • رمز عبور کاربران ادمین/ماشین را تغییر دهید

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

یک حساب مدیر در ماژول Edge SSO برای مدیریت ویژگی های ماژول مورد نیاز است.

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

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

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

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

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

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

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

نصب apigee-ssoadminapi.sh

ابزار apigee-ssoadminapi.sh روی گره Edge Management Server جایی که ماژول Edge SSO را نصب کرده اید، نصب کنید. معمولاً هنگام نصب ماژول Edge SSO، ابزار apigee-ssoadminapi.sh را نصب می کنید.

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

  1. وارد گره مدیریت سرور شوید. آن گره باید قبلاً apigee-service را همانطور که در Install the Edge apigee-setup utility توضیح داده شده نصب کرده باشد.
  2. ابزار apigee-ssoadminapi.sh را که برای مدیریت مدیران و کاربران ماشین برای ماژول Edge 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 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 از مقادیر پیش فرض 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