استفاده از ابزارهای کمکی سرپرست Edge و میاناهای برنامه‌سازی کاربردی پس‌از فعال کردن SAML

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

این بخش نحوه اجرای ابزارها و فرمان‌های سرپرست سیستم Edge را پس‌از فعال کردن SAML شرح می‌دهد. بسیاری از تکالیف در Edge به اطلاعات کاربری سرپرستی سامانه نیاز دارند، ازجمله:

  • درحال ایجاد سازمان‌ها و محیط‌ها
  • افزودن و برداشتن مؤلفه‌های Edge
  • درحال اجرای فرمان‌های apigee-adminapi.sh
  • بسیاری از تکالیف دیگر

بااین‌حال، پس‌از فعال کردن SAML در Edge، معمولاً Basic Auth را غیرفعال می‌کنید تا تنها راه اصالت‌سنجی ازطریق SAML IDP باشد. بنابراین، باید مطمئن شوید که حساب سرپرست سیستم را به SAML IDP خود اضافه کرده‌اید.

فراخوانی میاناهای برنامه‌سازی کاربردی مدیریت Edge به‌عنوان سرپرست سیستم

بسیاری از فراخوانی‌های Edge API مستلزم این است که اعتبارنامه‌های سرپرست سیستم را ارسال کنید. استفاده از SAML با Edge management API حاوی دستورالعمل‌هایی درباره نحوه دریافت و بازآوری کردن ژتون‌ها هنگام برقراری تماس‌های Edge management API است.

استفاده از ابزار کمکی apigee-adminapi.sh با اصالت‌سنجی SAML

از ابزار کمکی apigee-adminapi.sh برای انجام همان کارهای پیکربندی Edge که با برقراری تماس با API مدیریت Edge انجام می‌دهید استفاده کنید. مزیت ابزار کمکی apigee-adminapi.sh این است که:

  • استفاده از میانای خط فرمان ساده
  • تکمیل فرمان مبتنی بر زبانه را پیاده‌سازی می‌کند
  • اطلاعات راهنمایی و استفاده را ارائه می‌دهد
  • اگر تصمیم بگیرید میانای برنامه‌سازی کاربردی را امتحان کنید، می‌تواند فراخوانی میانای برنامه‌سازی کاربردی مربوطه را نمایش دهد

برای اطلاعات بیشتر، استفاده از apigee-ssoadminapi.sh را ببینید.

پس‌از فعال کردن اصالت‌سنجی SAML، چند روش برای ارسال اطلاعات کاربری سرپرست سیستم به ابزار کمکی apigee-adminapi.sh دارید.

می‌توانید همه گزینه‌های هر فرمان apigee-adminapi.sh را، ازجمله گزینه‌های مشخص کردن اطلاعات کاربری SAML، بااستفاده از گزینه «-h» در فرمان ببینید. برای مثال:

> apigee-adminapi.sh orgs list -h

برای مثال، می‌توانید اعتبارنامه سرپرست سیستم را ارسال کنید:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant --admin adminEmail --oauth-password adminPword 

مکان:

  • sso-url نشانی وب واحد Edge SSO را مشخص می‌کند. اگر درگاه یا پروتکل را از ۹۰۹۹ و HTTP تغییر داده‌اید، آن‌ها را اصلاح کنید.
  • oauth-flow یا passcode یا password_grant را مشخص می‌کند. در این مثال، password_grant را مشخص می‌کنید.
  • adminEmail نشانی ایمیل سرپرست سیستم است.
  • oauth-password گذرواژه مدیر سیستم را مشخص می‌کند.

یا می‌توانید هنگام فراخوانی فرمان از گذرنویسه استفاده کنید:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-passcode passcode 

مکان:

  • oauth-flow گذرنویسه را مشخص می‌کند.
  • oauth-passcode گذرنویسه به‌دست‌آمده از http://edge_sso_IP_DNS:9099/passcode را مشخص می‌کند.

درنهایت، می‌توانید هنگام فراخوانی فرمان از یک توکن استفاده کنید:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-token token 

مکان:

  • oauth-flow بسته به اینکه در ابتدا چگونه کد را دریافت کرده‌اید، passcode یا password_grant را مشخص می‌کند. در این مثال، گذرنویسه را مشخص می‌کنید زیرا در ابتدا بااستفاده از get_token، توکن را دریافت کرده‌اید. به استفاده از SAML با Edge management API مراجعه کنید.
  • oauh_token حاوی کد است.

استفاده از ابزارهای Edge با اصالت‌سنجی SAML

بسیاری از ابزارهای Edge به اطلاعات کاربری سرپرست سیستم نیاز دارند، ازجمله:

  • apigee-provision برای ایجاد سازمان‌ها، محیط‌ها، و میزبان‌های مجازی استفاده می‌شود
  • setup.sh برای افزودن گره‌ها به سیستم موجود استفاده می‌شود
  • هر ابزار دیگری که در آن باید اعتبارنامه سرپرست سیستم را در فایل پیکربندی مشخص کنید

این ابزارها فایل پیکربندی‌ای را به‌عنوان ورودی دریافت می‌کنند که اطلاعات کاربری سرپرست سیستم را بااستفاده از این ویژگی‌ها مشخص می‌کند:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

اگر گذرواژه را وارد نکنید، از شما خواسته می‌شود آن را وارد کنید.

پس‌از فعال کردن SAML، از ویژگی‌های مختلفی برای مشخص کردن اطلاعات اعتباری مدیر سیستم استفاده می‌کنید. برای مثال، می‌توانید اطلاعات کاربری سرپرست سیستم را ارسال کنید:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

مکان:

  • SSO_LOGIN_URL نشانی وب واحد Edge SSO را مشخص می‌کند. اگر درگاه یا پروتکل را از ۹۰۹۹ و HTTP تغییر داده‌اید، آن‌ها را اصلاح کنید.
  • OAUTH_FLOW گذرنویسه یا password_grant را مشخص می‌کند. در این مثال، password_grant را مشخص می‌کنید زیرا گذرواژه سرپرست سیستم را ارسال می‌کنید.
  • OAUTH_ADMIN_PASSWORD گذرواژه سرپرست سیستم را مشخص می‌کند.

یا می‌توانید از ویژگی‌های زیر برای مشخص کردن اعتبارنامه‌ها به‌عنوان بخشی از جریان گذرنویسه استفاده کنید:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

مکان:

  • OAUTH_FLOW گذرنویسه را مشخص می‌کند.
  • OAUTH_ADMIN_PASSCODE گذرنویسه به‌دست‌آمده از http://edge_sso_IP_DNS:9099/passcode را مشخص می‌کند.

درنهایت، می‌توانید از کد استفاده کنید

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

مکان:

  • OAUTH_FLOW بسته به اینکه در ابتدا چگونه رمز را دریافت کرده‌اید، passcode یا password_grant را مشخص می‌کند. در این مثال، گذرنویسه را مشخص می‌کنید زیرا در ابتدا بااستفاده از get_token، کد را دریافت کرده‌اید. به استفاده از SAML با Edge management API مراجعه کنید.
  • OAUTH_BEARER_TOKEN حاوی کد است.