คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
เมื่อใช้ SAML กับ Edge API กระบวนการที่คุณใช้เพื่อรับสิทธิ์เข้าถึง OAuth2 และ การรีเฟรชโทเค็นจากการยืนยัน SAML จะเรียกว่าขั้นตอนรหัสผ่าน ด้วยรหัสผ่าน ให้ใช้เบราว์เซอร์เพื่อรับรหัสผ่านแบบใช้ครั้งเดียว จากนั้นจะใช้เพื่อรับ OAuth2 โทเค็น
แต่สภาพแวดล้อมของคุณอาจรองรับการทำงานอัตโนมัติสำหรับงานการพัฒนาทั่วไป เช่น การทดสอบการทำงานอัตโนมัติ หรือการรวมอย่างต่อเนื่อง/การติดตั้งใช้งานอย่างต่อเนื่อง (CI/CD) ให้ทำงานอัตโนมัติ งานเหล่านี้เมื่อเปิดใช้ SAML คุณจะต้องหาวิธีรับและรีเฟรชโทเค็น OAuth2 ต้องคัดลอก/วางรหัสผ่านจากเบราว์เซอร์
เกี่ยวกับผู้ใช้เครื่อง
Apigee Edge รองรับผู้ใช้เครื่องในองค์กรที่เปิดใช้ SAML ผู้ใช้เครื่องนั้นใช้สำหรับการทำงานอัตโนมัติโดยเฉพาะ และมนุษย์ไม่ได้เข้าถึงโดยตรง
ผู้ใช้เครื่องสามารถรับโทเค็น OAuth2 ได้ โดยไม่ต้องระบุรหัสผ่าน นั่นหมายความว่าคุณสามารถทำให้ กระบวนการ การรับและรีเฟรชโทเค็น OAuth2 โดยใช้ Edge API
ขั้นตอนการสร้างโทเค็นโดยอัตโนมัติ
วิธีทำให้กระบวนการสร้างโทเค็นเป็นไปโดยอัตโนมัติ
ขั้นตอน | คำอธิบาย |
---|---|
1 | สร้างผู้ใช้เครื่องในโซนข้อมูลประจำตัว SAML |
2 | มอบหมายบทบาทที่จำเป็นให้กับผู้ใช้เครื่องในองค์กร Edge |
3 | รับโทเค็น OAuth2 ของผู้ใช้เครื่อง |
วิดีโอ: ดูวิดีโอสั้นๆ เพื่อดูวิธีเข้าถึง Apigee Edge API แบบอัตโนมัติโดยใช้ข้อมูลเข้าสู่ระบบของผู้ใช้เครื่อง
จัดการผู้ใช้เครื่องสำหรับโซนข้อมูลประจำตัว SAML
Apigee มีอินเทอร์เฟซบรรทัดคำสั่งสำหรับการจัดการผู้ใช้เครื่อง (CLI) สำหรับสร้างและจัดการบัญชีผู้ใช้เครื่อง ขั้นตอนการใช้ CLI สำหรับการจัดการผู้ใช้เครื่องมีอธิบายไว้ในส่วนต่อไปนี้
ใช้ CLI
หากต้องการใช้ CLI การจัดการผู้ใช้เครื่อง ให้ดาวน์โหลดและยกเลิกการอัปโหลดไฟล์ต่อไปนี้ก่อน
usermgmt.tar.gz
(1)
รูปแบบสำหรับการเรียก CLI มีดังนี้
usermgmt_platform [command] [flags]
ตารางต่อไปนี้สรุปแพลตฟอร์มที่รองรับและคำสั่งที่เกี่ยวข้องเพื่อเรียกใช้ CLI ในการจัดการผู้ใช้เครื่อง
(ไฟล์ปฏิบัติการอยู่ในไดเรกทอรี usermgmt
)
แพลตฟอร์ม | 32 บิต | 64 บิต |
---|---|---|
Linux | usermgmt_linux_386 |
usermgmt_linux_amd64 |
Mac | usermgmt_darwin_386 |
usermgmt_darwin_amd64 |
Windows | usermgmt_windows_386 |
usermgmt_windows_amd64 |
ตารางต่อไปนี้สรุปคำสั่งที่ระบุได้
คำสั่ง | ข้อมูลเพิ่มเติม |
---|---|
create
|
สร้างผู้ใช้เครื่องในโซนข้อมูลประจำตัว |
delete
|
ลบผู้ใช้เครื่องในโซนข้อมูลประจำตัว |
help
|
รับความช่วยเหลือโดยใช้ CLI |
list
|
แสดงรายการผู้ใช้เครื่องทั้งหมดในโซนข้อมูลประจำตัว |
reset
|
รีเซ็ตรหัสผ่านสำหรับผู้ใช้เครื่องในโซนข้อมูลประจำตัว |
คุณสามารถเลือกที่จะส่งการแจ้งอย่างใดอย่างหนึ่งต่อไปนี้เพื่อแสดงความช่วยเหลือตามคำสั่งที่ระบุ: -h หรือ --help
ลงชื่อเข้าใช้ CLI
ครั้งแรกที่คุณเรียกใช้ CLI ภายในระยะเวลา 24 ชั่วโมง ระบบจะแจ้งให้ป้อนข้อมูลเข้าสู่ระบบของบัญชี zoneadmin
Enter your Apigee credentials
Username: zoneadmin-username
Password: zoneadmin-password
If your user is opted with MFA, enter MFA code. Otherwise press enter to skip.
MFA: mfa-code_or_enter_to_skip
CLI สำหรับการจัดการผู้ใช้เครื่องจะจัดเก็บโทเค็นเพื่อการเข้าถึงไว้ในเครื่องของคุณ ดังนั้นคุณจึงต้องลงชื่อเข้าใช้เพียงครั้งเดียวในช่วงเวลา 24 ชั่วโมง
รับความช่วยเหลือในการใช้ CLI
แสดงข้อมูลการใช้งาน CLI โดยใช้คำสั่ง usermgmt_platform Help โปรดดูรายชื่อแพลตฟอร์มที่รองรับในใช้ CLI
usermgmt_platform help
ข้อมูลความช่วยเหลือต่อไปนี้จะปรากฏขึ้น
A command-line interface (CLI) to manage machine user accounts to automate
Apigee identity zone management. Use the CLI to create, list, delete,
and reset the password for machine users.
Usage:
usermgmt [flags]
usermgmt [command]
Available Commands:
create Creates a machine users in an identity zone.
delete Deletes a machine users in an identity zone.
help Help about any command
list Lists the machine users in an identity zone.
reset Resets the password for a machine user in an identity zone.
Flags:
-h, --help help for usermgmt
Use "usermgmt [command] --help" for more information about a command.
แสดงความช่วยเหลือในบางคำสั่งโดยการส่งทั้งคำสั่งและแฟล็ก -h หรือ --help ในบรรทัดคำสั่ง
เช่น หากต้องการความช่วยเหลือเกี่ยวกับคําสั่งรายการ ให้ทำดังนี้
usermgmt_platform list -h
ข้อมูลความช่วยเหลือต่อไปนี้จะปรากฏขึ้น
Lists the machine users in an identity zone.
Usage:
usermgmt list [flags]
Flags:
-h, --help help for list
สร้างผู้ใช้เครื่องในโซนข้อมูลประจำตัว
สร้างผู้ใช้เครื่องในโซนข้อมูลประจำตัวโดยใช้คำสั่ง usermgmt_platform create โปรดดูรายชื่อแพลตฟอร์มที่รองรับในใช้ CLI
- ป้อนคำสั่งต่อไปนี้
usermgmt_platform create
รายการโซนข้อมูลประจำตัวจะปรากฏขึ้นดังนี้
myzone1 myzone2
- ป้อนชื่อโซนที่พรอมต์
Enter a zone name: myzone1
- ป้อนชื่อผู้ใช้สำหรับผู้ใช้เครื่อง:
Create a Machine User Username: machineuser1@mycompany.com
- ป้อนรหัสผ่านสำหรับผู้ใช้เครื่อง ป้อนรหัสผ่านอีกครั้งเมื่อได้รับข้อความแจ้ง
Password: password Re-enter password: password
สร้างผู้ใช้แล้ว
Created machine user machineuser1@mycompany.com
แสดงรายการผู้ใช้เครื่องทั้งหมดในโซนข้อมูลประจำตัว
แสดงรายการผู้ใช้เครื่องทั้งหมดในโซนข้อมูลประจำตัวโดยใช้คำสั่ง usermgmt_platform list โปรดดูรายชื่อแพลตฟอร์มที่รองรับในใช้ CLI
- ป้อนคำสั่งต่อไปนี้
รายการโซนข้อมูลประจำตัวจะปรากฏขึ้นดังนี้ วันที่usermgmt_platform list
myzone1 myzone2
- ป้อนชื่อโซนที่พรอมต์
Enter a zone name: myzone1
ระบบจะแสดงรายชื่อผู้ใช้เครื่องในโซนข้อมูลประจำตัว ดังนี้
Machine users in the zone: machineuser1@mycompany.com
รีเซ็ตรหัสผ่านสำหรับผู้ใช้เครื่องในโซนข้อมูลประจำตัว
รีเซ็ตรหัสผ่านสำหรับผู้ใช้เครื่องในโซนข้อมูลประจำตัวโดยใช้คำสั่ง usermgmt_platformreset โปรดดูรายชื่อแพลตฟอร์มที่รองรับในใช้ CLI
- ป้อนคำสั่งต่อไปนี้
usermgmt_platform reset
รายการโซนข้อมูลประจำตัวจะปรากฏขึ้นดังนี้
myzone1 myzone2
- ป้อนชื่อโซนที่พรอมต์
Enter a zone name: myzone1
- ป้อนชื่อผู้ใช้สำหรับผู้ใช้เครื่องที่คุณต้องการรีเซ็ตรหัสผ่าน:
Reset User Password Enter the username for the machine user Username: machineuser1@mycompany.com
- ป้อนรหัสผ่านใหม่สำหรับผู้ใช้เครื่อง ป้อนรหัสผ่านอีกครั้งเมื่อได้รับข้อความแจ้ง
Enter the new password: password Re-enter password: password
ระบบจะรีเซ็ตรหัสผ่าน
Reset password for machine user machineuser1@mycompany.com
ลบผู้ใช้เครื่องในโซนข้อมูลประจำตัว
ลบผู้ใช้เครื่องในโซนข้อมูลประจำตัวโดยใช้คำสั่ง usermgmt_platform delete โปรดดูรายชื่อแพลตฟอร์มที่รองรับในใช้ CLI
- ป้อนคำสั่งต่อไปนี้
รายการโซนข้อมูลประจำตัวจะปรากฏขึ้นดังนี้ วันที่usermgmt_platform delete
myzone1 myzone2
- ป้อนชื่อโซนที่พรอมต์
Enter a zone name: myzone1
- ป้อนชื่อผู้ใช้สำหรับผู้ใช้เครื่องที่คุณต้องการลบ:
Delete User Enter the username for the machine user Username: machineuser1@mycompany.com
ผู้ใช้เครื่องจะถูกลบ
Deleted user machineuser1@mycompany.com
มอบหมายบทบาทที่จำเป็นให้กับผู้ใช้เครื่องในองค์กร Edge
เมื่อใช้ UI ให้เพิ่มผู้ใช้เครื่องไปยังองค์กร Edge ที่เปิดใช้ SAML และมอบหมายบทบาทที่จำเป็น (เช่น ผู้ดูแลระบบองค์กร) ตามที่อธิบายไว้ในการเพิ่มผู้ใช้
รับโทเค็น OAuth2 ของผู้ใช้เครื่อง
คุณสามารถทำให้กระบวนการสร้างโทเค็นทำงานโดยอัตโนมัติและจัดการการแคชโทเค็นสำหรับผู้ใช้เครื่องด้วย
ยูทิลิตี acurl
(1) และ get_token
(1) ตามที่อธิบายไว้ใน
OAuth2 สำหรับผู้ใช้เครื่องและผู้ใช้เครื่องในโซน SAML
วิธีรับโทเค็น OAuth2 ของผู้ใช้เครื่องด้วยตนเองด้วย curl
- ใช้เครื่องมือเข้ารหัส URL ที่ต้องการเพื่อเข้ารหัสชื่อผู้ใช้และรหัสผ่านของผู้ใช้เครื่อง
คำเตือน: ใช้เครื่องมือการเข้ารหัส URL
ภายใน เพื่อให้แน่ใจว่า ข้อมูลเข้าสู่ระบบของผู้ใช้เครื่องจะไม่ถูกเจาะระบบ - สร้างโทเค็นการเข้าถึงเริ่มต้นและรีเฟรชโทเค็นโดยเรียกใช้ปลายทางของโทเค็น SAML ตามตัวอย่างต่อไปนี้
curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \ -H "accept: application/json;charset=utf-8" \ -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \ https://zoneName.login.apigee.com/oauth/token -s \ -d 'grant_type=password&username=machineusername&password=machineuserpassword'
สำหรับการให้สิทธิ์ ให้ส่งผ่านข้อมูลเข้าสู่ระบบไคลเอ็นต์ OAuth2 ที่สงวนไว้
ZWRnZWNsaTplZGdlY2xpc2VjcmV0
ใน ส่วนหัวAuthorization
การเรียกใช้จะพิมพ์โทเค็นเพื่อการเข้าถึงและรีเฟรชเพื่อstdout
- ส่งโทเค็นเพื่อการเข้าถึงไปยังการเรียก Edge Management API เป็นส่วนหัวสำหรับผู้ถือ
curl -H "Authorization: Bearer ACCESS_TOKEN" \ https://api.enterprise.apigee.com/v1/organizations/orgName
- เมื่อโทเค็นเพื่อการเข้าถึงหมดอายุ คุณสามารถรีเฟรชได้โดยการส่งโทเค็นการรีเฟรชไปยัง SAML
ปลายทางของโทเค็นตามตัวอย่างต่อไปนี้
curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \ -H "Accept: application/json;charset=utf-8" \ -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \ https://zoneName.login.apigee.com/oauth/token \ -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'
(1) ลิขสิทธิ์ 2023 Google LLC
เครื่องมือ usermgmt
, acurl
และ get_token
มีให้บริการในชื่อ "ซอฟต์แวร์" ภายใต้
ข้อตกลงที่ควบคุมการใช้งาน Google Cloud Platform ของคุณ รวมถึงบริการ
ดูข้อกำหนดเฉพาะได้ที่ https://cloud.google.com/terms/service-terms