การใช้ get_token

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X
info

ยูทิลิตี get_token(1) ช่วยให้คุณแลกข้อมูลเข้าสู่ระบบ Apigee เป็นโทเค็นเพื่อการเข้าถึง และโทเค็นการรีเฟรชที่ใช้เข้าถึง Edge API ได้ นอกจากนี้ยังสามารถใช้โทเค็นกับSAML และการใช้งาน LDAP ของOAuth2 ได้ด้วย

get_token ช่วยให้คุณทำสิ่งต่อไปนี้ได้

  • รับโทเค็นเพื่อการเข้าถึงหรือโทเค็นการรีเฟรช
  • พิมพ์โทเค็นลงใน stdout เพื่อใช้ในตัวแปรและคำสั่ง
  • จัดเก็บโทเค็นไว้ในดิสก์

จากนั้นคุณสามารถเพิ่มโทเค็นที่ถูกต้องในคำขอไปยัง Edge API และรับโทเค็นใหม่เมื่อโทเค็นเดิมหมดอายุ

ข้อกำหนดเบื้องต้น: คุณต้อง ติดตั้ง get_token ก่อนจึงจะใช้งานได้

ไวยากรณ์ของ get_token

ยูทิลิตี get_token ใช้ไวยากรณ์ต่อไปนี้

get_token -u USERNAME:PASSWORD [-m MFACODE]

หรือ

get_token -p passcode

สถานที่:

องค์ประกอบ จำเป็นหรือไม่ คำอธิบาย
USERNAME ไม่บังคับ ต้องระบุชุดชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่านแบบใช้ครั้งเดียว ชื่อผู้ใช้ Apigee ซึ่งโดยปกติจะเป็นอีเมลที่เชื่อมโยงกับบัญชี Apigee คุณต้องส่งชื่อผู้ใช้หรือรหัสผ่านแบบใช้ครั้งเดียวเมื่อเรียกใช้ get_token เป็นครั้งแรก คุณจะไม่ต้องส่งอีเมล อีกครั้งจนกว่าโทเค็นเพื่อการเข้าถึงและโทเค็นการรีเฟรชจะหมดอายุ หากแคชโทเค็น สำหรับผู้ใช้มากกว่า 1 ราย คุณต้องระบุชื่อผู้ใช้ในการเรียกใช้แต่ละครั้ง
PASSWORD ไม่บังคับ ต้องระบุชุดชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่านแบบใช้ครั้งเดียว รหัสผ่านสำหรับบัญชี Apigee หากไม่ระบุรหัสผ่าน ระบบจะแจ้งให้คุณป้อนรหัสผ่านเมื่อใช้ get_token เป็นครั้งแรก และในการเรียกใช้ครั้งต่อๆ ไปโดยไม่มีโทเค็นการรีเฟรชที่ถูกต้อง หากไม่ต้องการใช้รหัสผ่านโดยตรงในคำสั่ง คุณสามารถใช้รหัสผ่านแบบใช้ครั้งเดียวแทนรหัสผ่านได้
MFACODE ไม่บังคับ รหัสการตรวจสอบสิทธิ์ แบบหลายปัจจัย (MFA) แบบใช้ครั้งเดียว 6 หลัก คุณต้องระบุรหัสนี้หากใช้ -u และเปิดใช้ MFA ระบบจะแจ้งให้คุณป้อนรหัสหากไม่ระบุ (ยกเว้นในโหมดรหัสผ่านแบบใช้ครั้งเดียว) หากไม่ได้เปิดใช้ MFA หรือมีโฟลว์ที่เขียนสคริปต์ไว้ คุณสามารถระบุ -m "" เพื่อหลีกเลี่ยงการแจ้งเตือน
PASSCODE ไม่บังคับ ต้องระบุชุดชื่อผู้ใช้และรหัสผ่านหรือรหัสผ่านแบบใช้ครั้งเดียว รหัสผ่านแบบใช้งานครั้งเดียวที่คุณใช้แทน รหัสผ่านได้ คุณต้องระบุรหัสผ่านแบบใช้ครั้งเดียวเมื่อตรวจสอบสิทธิ์กับ SAML IDP และอาจใช้ เพื่อตรวจสอบสิทธิ์กับ LDAP IDP ได้

เช่น

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

การเรียกใช้ที่สำเร็จจะพิมพ์โทเค็นเพื่อการเข้าถึงที่ถูกต้องลงใน stdout และจัดเก็บทั้งโทเค็นเพื่อการเข้าถึงและโทเค็นการรีเฟรชไว้ใน ~/.sso-cli คุณสามารถใช้โทเค็นเหล่านี้ได้จนกว่าจะหมดอายุตามที่อธิบายไว้ในส่วนการหมดอายุของโทเค็น

หลังจากเรียกใช้ get_token สำเร็จเป็นครั้งแรก คุณไม่จำเป็นต้องระบุข้อมูลเข้าสู่ระบบ จนกว่าโทเค็นจะหมดอายุ

เรียกใช้ get_token เป็นครั้งแรก

หากไม่ระบุตัวเลือกใดๆ ในการเรียกใช้ครั้งแรก get_token จะแจ้งให้คุณระบุข้อมูลต่อไปนี้

  • รหัสผ่านแบบใช้ครั้งเดียว หากตรวจสอบสิทธิ์กับผู้ให้บริการข้อมูลประจำตัว (IDP) ของ SAML
  • ชื่อผู้ใช้ รหัสผ่าน และรหัส MFA แบบใช้ครั้งเดียว ในกรณีอื่นๆ

ตัวอย่างต่อไปนี้เรียกใช้ get_token เป็นครั้งแรกและใช้ชุดชื่อผู้ใช้/รหัสผ่านพร้อมรหัส MFA ที่ไม่บังคับสำหรับการตรวจสอบสิทธิ์

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

เพิ่มโทเค็นเพื่อการเข้าถึงลงในคำขอ

หลังจากเรียกใช้ get_token สำเร็จแล้ว คุณสามารถใช้โทเค็นเพื่อการเข้าถึงได้โดยส่งโทเค็นในส่วนหัว Authorization ของการเรียกใช้ Edge API ได้หลายวิธี โดยคุณสามารถทำดังนี้

  • คัดลอกเนื้อหาของการตอบกลับ get_token และแทรกลงในส่วนหัวของคุณโดยตรง
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
      -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • รวมคำสั่งเพื่อรับโทเค็นและเพิ่มลงในส่วนหัว
    token=$(get_token); curl -H "Authorization: Bearer $token" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    โปรดทราบว่า get_token ใช้ไวยากรณ์การแทนที่คำสั่ง $(...) เพื่อให้มีการดำเนินการ

  • เรียกใช้ get_token ภายในคำสั่ง curl
    curl -H "Authorization: Bearer $(get_token)" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    โปรดทราบว่า get_token ใช้ไวยากรณ์การแทนที่คำสั่ง $(...) เพื่อให้มีการดำเนินการ

คำขอตัวอย่างเหล่านี้จะรับรายละเอียดเกี่ยวกับองค์กร "ahamilton-eval" ดูรายการปลายทาง Edge API ทั้งหมด ได้ที่ ข้อมูลอ้างอิง Apigee Edge API

ใช้ get_token กับ SAML และ LDAP

ยูทิลิตี get_token สามารถใช้กับ SAML, LDAP หรือ IDP อื่นๆ ที่เกี่ยวข้องได้ get_token รองรับการใช้ URL การเข้าสู่ระบบ SSO หลายรายการและบัญชีหลายบัญชี ระบบจะแจ้งให้ผู้ใช้รายเดียวที่มีหลายบัญชีระบุชื่อผู้ใช้ สำหรับการเรียกใช้ get_token แต่ละครั้ง

ล้างแคช get_token

คุณสามารถใช้แฟล็กที่ไม่บังคับต่อไปนี้เพื่อล้างแคช get_token

  • --clear-sso-cache

    ล้างไดเรกทอรีแคชสำหรับ SSO_LOGIN_URL ภายใต้ $HOME/.sso-cli โดยทิ้งโทเค็นเพื่อการเข้าถึงและโทเค็นการรีเฟรชที่แคชไว้สำหรับเซิร์ฟเวอร์

  • --clear-all-sso-cache

    ล้างไดเรกทอรีทั้งหมดภายใต้ $HOME/.sso-cli โดยทิ้งโทเค็นที่แคชไว้ทั้งหมด


(1) Copyright 2023 Google LLC
เครื่องมือ get_token พร้อมให้ใช้งานเป็น "ซอฟต์แวร์" ภายใต้ ข้อตกลงที่ควบคุมการใช้งาน Google Cloud Platform รวมถึงข้อกำหนดเฉพาะ บริการซึ่งระบุไว้ที่ https://cloud.google.com/terms/service-terms