คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
ยูทิลิตี acurl
(1) จะมอบ Wrapper ของความสะดวกตามcurl
มาตรฐาน
คำสั่ง acurl
:
- แลกเปลี่ยนข้อมูลเข้าสู่ระบบ Apigee สำหรับโทเค็นการเข้าถึง OAuth2
- ตรวจจับเมื่อโทเค็นเพื่อการเข้าถึงหมดอายุ และใช้โทเค็นการรีเฟรชเพื่อรับโทเค็นเพื่อการเข้าถึงใหม่
- ส่งโทเค็นดังกล่าวในส่วนหัว
Authorization
ของคำขอ API
คุณใช้โทเค็นเพื่อการเข้าถึงเพื่อเรียกปลายทาง Edge API ด้วย OAuth2 ซึ่งรวมถึง เวิร์กโฟลว์ LDAP และ SAML
หากใช้ OAuth2 เพื่อเข้าถึง Edge API แต่ไม่ได้ใช้ acurl
คุณจะต้อง
รับโทเค็นเพื่อการเข้าถึงแล้วเพิ่มลงในส่วนหัวของคำขอ API ด้วยตนเอง วิธีหนึ่งในการรับ
โทเค็นเพื่อการเข้าถึงมีในยูทิลิตี get_token
ติดตั้ง acurl
ก่อนที่คุณจะใช้ acurl
ได้ คุณต้อง
ติดตั้ง
ไวยากรณ์ acurl
ยูทิลิตี acurl
ใช้ไวยากรณ์ต่อไปนี้
acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]
หรือ
acurl API_URL -p PASSCODE
สถานที่:
ตัวเลือก | จำเป็นหรือไม่ | คำอธิบาย |
---|---|---|
API_URL | จำเป็น | ปลายทาง Apigee Edge API ดูรายการปลายทางทั้งหมดได้ที่ข้อมูลอ้างอิง Apigee Edge API |
USERNAME | ไม่บังคับ ต้องกรอกชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่าน | ชื่อผู้ใช้ Apigee ของคุณซึ่งมักจะเป็นอีเมลที่เชื่อมโยงกับบัญชี Apigee ของคุณ
คุณต้องส่งชื่อผู้ใช้หรือรหัสผ่านเมื่อโทรหา get_token เป็นครั้งแรก
คุณไม่จำเป็นต้องส่งอีเมล
อีกครั้งจนกว่าโทเค็นเพื่อการเข้าถึงและการรีเฟรชจะหมดอายุ หากคุณกำลังแคชโทเค็น
สำหรับผู้ใช้มากกว่า 1 ราย คุณต้องระบุชื่อผู้ใช้ในการโทรแต่ละครั้ง |
PASSWORD | ไม่บังคับ ต้องกรอกชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่าน | รหัสผ่านสำหรับบัญชี Apigee หากคุณไม่ใส่รหัสผ่าน ระบบจะแจ้งให้
ป้อนรหัสดังกล่าวในครั้งแรกที่คุณใช้ acurl และในการโทรครั้งต่อๆ มาโดยไม่มีหมายเลขที่ถูกต้อง
โทเค็นการรีเฟรช หากคุณไม่ต้องการใช้รหัสผ่านโดยตรงในคำสั่ง คุณสามารถใช้
รหัสผ่านแบบใช้ครั้งเดียวแทนรหัสผ่าน |
MFACODE | ไม่บังคับ | ปัจจัยชั่วคราว 6 หลักแบบหลายปัจจัย
Authentication (MFA) ต้องใช้รหัสนี้หากคุณใช้ -u และเปิดใช้งาน MFA ไว้
คุณจะได้รับข้อความแจ้งหากไม่มีการระบุไว้ (ยกเว้นในโหมดรหัสผ่าน) หากไม่ได้ตั้งค่า MFA ไว้หรือคุณมีขั้นตอนที่ใช้สคริปต์
คุณสามารถระบุ -m "" เพื่อหลีกเลี่ยงข้อความแจ้งได้ |
PASSCODE | ไม่บังคับ ต้องกรอกชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่าน | รหัสผ่านแบบใช้งานครั้งเดียวที่คุณสามารถใช้แทน รหัสผ่าน ต้องป้อนรหัสผ่านเมื่อตรวจสอบสิทธิ์กับ SAML IDP รวมทั้งอาจต้องใช้รหัสผ่านดังกล่าวด้วย เพื่อตรวจสอบสิทธิ์ด้วย LDAP IDP |
เช่น
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-evalacurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com -p 424242
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd -m 123456
นอกจากตัวเลือกที่แสดงข้างต้น acurl
ยังยอมรับcurl
ทั้งหมด
ตัวเลือก ตัวอย่างเช่น คุณสามารถส่งส่วนหัว ระบุคำกริยา HTTP เพิ่มเนื้อความ และเปิดใช้งาน
การพูดรายละเอียดโดยใช้ตัวเลือก curl
มาตรฐาน:
ตัวเลือก | acurl meaning |
curl meaning |
---|---|---|
-u | username |
username |
-นาที | MFA code |
max time (ต้องใช้แบบยาว --max-time ) |
-p | passcode |
proxy tunnel (ต้องใช้แบบยาว --proxytunnel ) |
-v | verbose |
verbose |
-ชม. | help |
help (ต้องใช้แบบยาว --help ) |
acurl -v -X POST -H 'Content-Type: application/json' \ https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apiproducts/myproduct/attributes/attr \ -u ahamilton@apigee.com -d '{"value":42}'
การเรียก acurl
ที่สำเร็จจะแสดงผลลัพธ์ตามปลายทาง Edge API ที่คุณ
โทรออก นอกจากนี้ acurl
ยังจัดเก็บทั้งโทเค็นเพื่อการเข้าถึงและการรีเฟรช
ใน ~/.sso-cli
คุณยังโทรออกได้โดยไม่ต้องป้อนข้อมูลเข้าสู่ระบบ (รหัสผ่านและ MFA หรือรหัสผ่านที่ไม่บังคับ) จนกว่าทั้งโทเค็นเพื่อการเข้าถึงและ โทเค็นการรีเฟรชจะหมดอายุตามที่อธิบายไว้ในการหมดอายุของโทเค็น
ย้ายข้อมูลจาก curl
หากคุณใช้ curl
การย้ายข้อมูลไปยังยูทิลิตี acurl
จะไม่ซับซ้อนและ
ช่วยลดความจำเป็นในการเข้ารหัสข้อมูลเข้าสู่ระบบด้วยตนเอง เมื่อคุณดาวน์โหลดและติดตั้งยูทิลิตีแล้ว คุณสามารถ
แทนที่:
curl -u username
กับ
วันที่ acurl -u username
ยูทิลิตี acurl
จะเข้ารหัส
ข้อมูลเข้าสู่ระบบ และบางครั้งอาจถามถึงข้อมูลเข้าสู่ระบบเพิ่มเติมที่จําเป็นในการรับคู่โทเค็นใหม่
ยูทิลิตี acurl
ยังใช้แทนที่ curl
สำหรับผู้ใช้เครื่องได้ด้วย สำหรับข้อมูลเพิ่มเติม
โปรดดู OAuth2 สำหรับผู้ใช้เครื่องและผู้ใช้เครื่องในโซน SAML
โทรหา acurl เป็นครั้งแรก
ครั้งแรกที่เรียกใช้ API ด้วย acurl
คุณต้องระบุข้อมูลเข้าสู่ระบบ Apigee (
ชื่อผู้ใช้และรหัสผ่านของบัญชี Apigee หรือรหัสผ่าน) เพื่อให้
acurl
สามารถแลกเปลี่ยนเป็นโทเค็นเพื่อการเข้าถึงและรีเฟรชโทเค็นได้
ตัวอย่างต่อไปนี้แสดงการโทรครั้งแรกกับ acurl
เพื่อสอบถามรายละเอียดเกี่ยวกับ
ขององค์กรโดยใช้ Get
องค์กรปลายทาง:
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \ -u ahamilton@apigee.com Enter the password for user 'ahamilton@apigee.com':[hidden input]
Enter the six-digit code (no spaces) if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:1a2b3c
{ "createdAt" : 1491854501264, "createdBy" : "noreply_iops@apigee.com", "displayName" : "ahamilton", "environments" : [ "prod", "test" ], "lastModifiedAt" : 1491854501264, "lastModifiedBy" : "noreply_iops@apigee.com", "name" : "ahamilton", "properties" : { "property" : [ { "name" : "features.isSmbOrganization", "value" : "false" }, { "name" : "features.isCpsEnabled", "value" : "true" } ] }, "type" : "trial" }
ยูทิลิตี acurl
จะได้รับโทเค็นเพื่อการเข้าถึงและแทรกลงในการเรียกใช้ไปยัง
อุปกรณ์ปลายทาง Edge API:
curl -H "Authorization: Bearer oauth2_access_token" ...
ระบบจะจัดเก็บโทเค็นเพื่อการเข้าถึงไว้ในเครื่อง ~/.sso-cli
และใช้สำหรับ
การโทรครั้งต่อๆ ไป
หลังจากที่โทเค็นเพื่อการเข้าถึงหมดอายุ acurl
จะใช้โทเค็นการรีเฟรชโดยอัตโนมัติเพื่อรับ
โทเค็นเพื่อการเข้าถึงใหม่ เมื่อโทเค็นการรีเฟรชหมดอายุ acurl
จะแสดงข้อความแจ้งคุณ
สำหรับข้อมูลเข้าสู่ระบบ Apigee ของคุณ
คำขอนี้จะได้รับรายละเอียดเกี่ยวกับ "ahamilton-eval" องค์กร หากต้องการดูรายการทั้งหมด ปลายทาง Edge API โปรดดูข้อมูลอ้างอิง Apigee Edge API
(1) ลิขสิทธิ์ 2023 Google LLC
เครื่องมือ acurl
พร้อมให้ใช้งานในรูปแบบของ "ซอฟต์แวร์" ภายใต้
ข้อตกลงที่ควบคุมการใช้งาน Google Cloud Platform ของคุณ รวมถึงบริการ
ดูข้อกำหนดเฉพาะได้ที่ https://cloud.google.com/terms/service-terms