שימוש בכלים לניהול אתרים ובממשקי API של Edge לאחר הפעלת SAML

Edge for Private Cloud גרסה 4.18.05

בקטע הזה מוסבר איך להריץ את הפקודות והכלים לניהול מערכת של Edge אחרי הפעלת SAML. למשימות רבות ב-Edge יש צורך בפרטי כניסה לניהול מערכת, כמו:

  • יצירת ארגונים וסביבות
  • הוספה והסרה של רכיבי Edge
  • פקודות Runngin apigee-adminapi.sh

עם זאת, אחרי שמפעילים SAML ב-Edge, בדרך כלל משביתים את Basic Auth, כך שהדרך היחידה לבצע אימות היא באמצעות SAML IDP. לכן חשוב לוודא שהוספת את חשבון האדמין של המערכת ל-IdP שלך ב-SAML.

קריאה לממשקי API לניהול Edge בתור מנהל המערכת

לקריאות רבות ל-Edge API יש להעביר פרטי כניסה של מנהל מערכת. השימוש ב-SAML עם Edge Management API כולל הוראות לקבלת אסימונים ולרענון שלהם במהלך קריאות ל-Edge Management API.

שימוש בכלי apigee-adminapi.sh עם אימות SAML

משתמשים בכלי השירות apigee-adminapi.sh כדי לבצע את אותן משימות של הגדרת Edge שמבצעים קריאות ל-Edge Management API. היתרון של הכלי 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 מציינת את כתובת ה-URL של מודול ה-SSO ל-Edge. אם שיניתם את היציאה או את הפרוטוקול מ-9099 ומ-HTTP, עליכם לשנות את היציאה או הפרוטוקול.
  • השדה oauth-flow מציין את הערך passcode או את password_grant. בדוגמה הזו מציינים את הערך password_grant.
  • adminEmail היא כתובת האימייל של אדמין ה-sys.
  • oauth-password מציין את הסיסמה של אדמין ה-sys.

לחלופין, אפשר להשתמש בקוד גישה כשאתם מפעילים את הפקודה:

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 עם Edge Management API.
  • oauh_token מכיל את האסימון.

שימוש בכלי שירות של Edge עם אימות SAML

לכלי שירות רבים של Edge נדרשים פרטי כניסה של מנהל מערכת, כמו:

  • הדומיין apigee-provision משמש ליצירת ארגונים, סביבות ומארחים וירטואליים
  • נעשה שימוש בפרמטר setup.sh כדי להוסיף צמתים למערכת קיימת
  • כל כלי שירות אחר שבו צריך לציין את פרטי הכניסה של מנהל המערכת בקובץ תצורה

הכלים האלה משתמשים בתור קלט בקובץ תצורה, שבו מצוינים פרטי הכניסה של מנהל המערכת באמצעות המאפיינים:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

אם תשמיטו את הסיסמה, תתבקשו להזין אותה.

אחרי שמפעילים את SAML, משתמשים בנכסים שונים כדי לציין את פרטי הכניסה של האדמין ב-sys. לדוגמה, אפשר להעביר את פרטי הכניסה של האדמין:

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

כאשר:

  • המדיניות SSO_LOGIN_URL מציינת את כתובת ה-URL של מודול ה-SSO של Edge. אם שיניתם את היציאה או את הפרוטוקול מ-9099 ומ-HTTP, צריך לשנות אותם.
  • השדה OAUTH_FLOW מציין את הערך passcode או את הערך password_grant. בדוגמה הזו מציינים את password_grant כי מעבירים את הסיסמה של האדמין של ה-sys.
  • OAUTH_ADMIN_PASSWORD מציין את הסיסמה של אדמין ה-sys.

לחלופין, אפשר להשתמש במאפיינים הבאים כדי לציין את פרטי הכניסה כחלק מתהליך קוד הגישה:

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 עם Edge Management API.
  • OAUTH_BEARER_TOKEN מכיל את האסימון.