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

Edge for Private Cloud v4.18.05

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

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

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

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

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

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

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

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

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

מידע על משתמשי מכונה

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

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

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

מידע נוסף זמין במאמר שימוש ב-SAML עם משימות אוטומטיות.

התקנת apigee-ssoadminapi.sh

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

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

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