שימוש ב-apigee-ssoadminapi.sh

Edge for Private Cloud גרסה 4.18.05

מודול SSO של Edge תומך בשני סוגי חשבונות:

  • אדמין
  • משתמש במכונה

בכלי העזר apigee-ssoadminapi.sh אפשר לנהל את האדמין ואת המשתמשים במכונות שמשויכים למודול ה-SSO של Edge.

השתמש בכלי השירות apigee-ssoadminapi.sh כדי:

  • הצגת רשימה של מנהלי מערכת/משתמשים במכונה
  • הוספה או מחיקה של אדמין/משתמשים במכונה
  • שינוי הסיסמה של מנהלי מערכת/משתמשים במכונה

מידע על משתמשים עם הרשאת אדמין

כדי לנהל את המאפיינים של המודול, יש צורך בחשבון אדמין במודול ה-SSO של Edge.

כברירת מחדל, כשמתקינים את מודול ה-SSO של Edge נוצר חשבון אדמין עם פרטי הכניסה הבאים:

  • שם משתמש: מוגדר על ידי המאפיין SSO_ADMIN_NAME בקובץ התצורה שמשמש להגדרת מודול ה-SSO של Edge. ברירת המחדל היא ssoadmin.
  • password: מוגדר על ידי המאפיין SSO_ADMIN_SECRET בקובץ התצורה שמשמש להגדרת מודול ה-SSO של Edge.

מידע על משתמשים במכונות

משתמש במכונה יכול לקבל אסימוני OAuth2 בלי לציין קוד גישה. המשמעות היא שיש לך אפשרות להפוך את תהליך הקבלה והרענון של אסימוני OAuth2 לאוטומטי באמצעות ממשק ה-API לניהול Edge.

בדרך כלל משתמשים במכונות כדי:

  • הגדרת הפורטל של Apigee Developer Services (או פשוט הפורטל) לתקשורת עם Edge
  • כשסביבת הפיתוח תומכת באוטומציה למשימות פיתוח נפוצות, כמו אוטומציה של בדיקות או אינטגרציה רציפה/פריסה רציפה (CI/CD).

למידע נוסף, תוכלו לקרוא את המאמר שימוש ב-SAML עם משימות אוטומטיות.

ההתקנה של apigee-ssoadminapi.sh

צריך להתקין את כלי השירות apigee-ssoadminapi.sh בצומת של שרת ניהול Edge שבו התקנת את מודול ה-SSO של Edge. בדרך כלל מתקינים את תוכנת השירות apigee-ssoadminapi.sh כשמתקינים את מודול ה-SSO של Edge.

אם עדיין לא התקנת את כלי השירות apigee-ssoadminapi.sh:

  1. נכנסים לצומת של שרת הניהול. apigee-service כבר אמור להיות מותקן בצומת הזה, כפי שמתואר בהתקנת כלי השירות Edge apigee-setup.
  2. מתקינים את כלי השירות apigee-ssoadminapi.sh שמשמש לניהול של אדמינים ומשתמשים במכונות במודול SSO של Edge: 
    /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 כי המודול SSO של Edge משתמש בערכי ברירת המחדל 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