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

Edge for Private Cloud نسخه 4.19.01

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

  • ایجاد سازمان ها و محیط ها
  • افزودن و حذف اجزای Edge
  • دستورات Runngin apigee-adminapi.sh

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

فراخوانی API های مدیریت Edge به عنوان مدیر سیستم

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

با استفاده از ابزار apigee-adminapi.sh با احراز هویت SAML

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

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

برای اطلاعات بیشتر، استفاده از 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 را مشخص می کند. اگر پورت یا پروتکل را از 9099 و 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 passcode مشخص می کند.
  • 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 را مشخص می‌کند. در این مثال، شما passcode را مشخص می‌کنید زیرا در ابتدا توکن را با استفاده از get_token دریافت کرده‌اید. استفاده از SAML با API مدیریت Edge را ببینید.
  • 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 URL ماژول Edge SSO را مشخص می کند. اگر پورت یا پروتکل را از 9099 و HTTP تغییر داده اید، تغییر دهید.
  • OAUTH_FLOW یا passcode یا 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 passcode مشخص می کند.
  • 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 را مشخص می‌کند. در این مثال، شما passcode را مشخص می‌کنید زیرا در ابتدا توکن را با استفاده از get_token دریافت کرده‌اید. استفاده از SAML با API مدیریت Edge را ببینید.
  • OAUTH_BEARER_TOKEN حاوی رمز است.