การใช้ apigee-ssoadminapi.sh

Edge สำหรับ Private Cloud เวอร์ชัน 4.18.05

โมดูล Edge SSO รองรับบัญชี 2 ประเภท ดังนี้

  • ผู้ดูแลระบบ
  • ผู้ใช้เครื่อง

ยูทิลิตี apigee-ssoadminapi.sh ช่วยให้คุณจัดการผู้ดูแลระบบและผู้ใช้เครื่องที่เชื่อมโยงกับโมดูล Edge SSO ได้

ใช้ยูทิลิตี apigee-ssoadminapi.sh เพื่อ:

  • ดูรายชื่อผู้ดูแลระบบ/ผู้ใช้เครื่อง
  • เพิ่มหรือลบผู้ใช้ที่ดูแลระบบ/เครื่อง
  • เปลี่ยนรหัสผ่านของผู้ดูแลระบบ/ผู้ใช้เครื่อง

เกี่ยวกับผู้ใช้ที่ดูแลระบบ

ต้องใช้บัญชีผู้ดูแลระบบในโมดูล Edge SSO เพื่อจัดการพร็อพเพอร์ตี้ของโมดูล

โดยค่าเริ่มต้น เมื่อคุณติดตั้งโมดูล Edge SSO จะเป็นการสร้างบัญชีผู้ดูแลระบบด้วยข้อมูลเข้าสู่ระบบต่อไปนี้

  • username: ตามพร็อพเพอร์ตี้ SSO_ADMIN_NAME ในไฟล์การกำหนดค่าที่ใช้กำหนดค่าโมดูล Edge SSO ค่าเริ่มต้นคือ ssoadmin.
  • password: กำหนดโดยพร็อพเพอร์ตี้ SSO_ADMIN_SECRET ในไฟล์การกำหนดค่าที่ใช้กำหนดค่าโมดูล Edge SSO

เกี่ยวกับผู้ใช้เครื่อง

ผู้ใช้เครื่องสามารถรับโทเค็น OAuth2 ได้โดยไม่ต้องระบุรหัสผ่าน ซึ่งหมายความว่าคุณจะทำให้กระบวนการรับและรีเฟรชโทเค็น OAuth2 เป็นแบบอัตโนมัติได้โดยใช้ Edge Management API

โดยทั่วไปแล้ว คุณจะใช้ผู้ใช้เครื่องเพื่อทำสิ่งต่อไปนี้

  • การกำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee (หรือเรียกง่ายๆ ว่าพอร์ทัล) เพื่อสื่อสารกับ Edge
  • เมื่อสภาพแวดล้อมในการพัฒนาซอฟต์แวร์รองรับการทำงานอัตโนมัติสำหรับการพัฒนาทั่วไป เช่น การทำงานอัตโนมัติสำหรับการทดสอบหรือการผสานรวมอย่างต่อเนื่อง/การติดตั้งใช้งานอย่างต่อเนื่อง (CI/CD)

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการใช้ SAML กับงานอัตโนมัติ

กำลังติดตั้ง apigee-ssoadminapi.sh

ติดตั้งยูทิลิตี apigee-ssoadminapi.sh ในโหนด Edge Management Server ที่คุณติดตั้งโมดูล Edge SSO ไว้ โดยทั่วไปคุณจะติดตั้งยูทิลิตี apigee-ssoadminapi.sh เมื่อติดตั้งโมดูล Edge SSO

ถ้าคุณยังไม่ได้ติดตั้งยูทิลิตี apigee-ssoadminapi.sh:

  1. เข้าสู่ระบบโหนด Management Server โหนดดังกล่าวควรมี apigee-service ติดตั้งไว้อยู่แล้วตามที่อธิบายไว้ในติดตั้งยูทิลิตี Edge apigee-setup
  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 เนื่องจากโมดูล Edge SSO ใช้ค่าเริ่มต้น 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