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

מודול הכניסה היחידה של Apigee תומך בשני סוגי חשבונות:

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

אפשר להשתמש בכלי העזר apigee-ssoadminapi.sh כדי:

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

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

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

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

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

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

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

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

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

למידע נוסף, ראו אוטומציה של משימות לספקי IdP חיצוניים.

מתבצעת התקנה של apigee-ssoadminapi.sh

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

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

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