การใช้ apigee-ssoadminapi.sh

Edge for Private Cloud v4.18.05

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

• administrator
• ผู้ใช้เครื่อง

ยูทิลิตี 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 Developer Services (หรือเรียกสั้นๆ ว่าพอร์ทัล) เพื่อสื่อสารกับ Edge
• เมื่อสภาพแวดล้อมในการพัฒนาซอฟต์แวร์รองรับการทำงานอัตโนมัติสำหรับงานพัฒนาทั่วไป เช่น การทดสอบอัตโนมัติหรือการรวมอย่างต่อเนื่อง/การติดตั้งใช้งานอย่างต่อเนื่อง (CI/CD)

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

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

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

หากคุณยังไม่ได้ติดตั้งยูทิลิตี 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. ออกจากระบบเชลล์ แล้วลงชื่อเข้าสู่ระบบอีกครั้งเพื่อเพิ่มยูทิลิตี 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