使用 Edge OAuth2 服務取得權杖

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

您可以使用 Edge OAuth2 服務交換憑證來取得存取權和更新權杖 之後,您會使用 Vertex AI 中的 OAuth 工作流程。

除了本節所述的技術之外,您也可以使用 acurl 和 用於取得 OAuth2 權杖的 get_token 公用程式。

路徑

POST https://login.apigee.com/oauth/token

如果您會透過 Edge for Public Cloud 已啟用 SAML 的機構存取 Edge OAuth2 服務, 必須在路徑中包含區域名稱。例如:

POST https://zone.login.apigee.com/oauth/token

要求標頭

參數
Content-Type "application/x-www-form-urlencoded"
Accept 「application/json;charset=utf-8」
Authorization

「Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0」

您可以將這個值匯出為環境變數,方便在各變數中重複使用 以及 API 呼叫例如:

export CLIENT_AUTH=ZWRnZWNsaTplZGdlY2xpc2VjcmV0
curl ... -H "Authorization: Basic $CLIENT_AUTH" ...

表單參數

參數 必填與否
username 選填。必須輸入使用者名稱和密碼組合或密碼。 您的 Apigee 使用者名稱,通常是與 Apigee 帳戶相關聯的電子郵件地址。
password 選填。必須輸入使用者名稱和密碼組合或密碼。 您的 Apigee 帳戶密碼。
mfa_token 選用 你帳戶的有效多重驗證 (MFA) 代碼。只有在您具備 已啟用多重驗證功能
passcode 選填。必須輸入使用者名稱和密碼組合或密碼。 一次性密碼,可取代 密碼。透過 SAML IDP 進行驗證時,必須提供密碼,且系統可使用密碼 使用 LDAP IDP 進行驗證
grant_type 必要

決定要取得新的存取權杖還是更新現有權杖。有效 包括:

  • "password":取得新的存取權杖。當 grant_type 為「password」時, 您必須在要求中加入 Apigee 憑證。
  • "refresh_token":請傳送更新憑證來取得新的存取權杖。時間 grant_type 是「refresh_token」,您不需要加入 使用憑證
refresh_token 選用 目前存取權杖 已過期。如果 grant_type 是「refresh_token」,就必須使用這個參數。

範例

,瞭解如何調查及移除這項存取權。

取得新的存取權杖

如要取得新的存取權杖,請將 grant_type 設為「password」:

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://login.apigee.com/oauth/token \
      -d 'username=ahamilton@example.com&password=mypassw0rd&grant_type=password'

透過 MFA 取得新的存取權杖

若要取得已啟用 MFA (多因素驗證) 的新存取權杖, 取得 MFA 代碼 然後將 mfa_token 參數設為它的值:

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://login.apigee.com/oauth/token?mfa_token=424242 \
  -d 'username=ahamilton@example.com&password=mypassw0rd&grant_type=password'

重新整理存取權杖

如要重新整理存取權杖,請將 grant_type 設為「refresh_token」並新增 做為表單參數:

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://login.apigee.com/oauth/token \
  -d 'grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN'

請注意,更新存取權杖時,不需要傳遞憑證。

回應

成功後,您會取得存取權杖、更新權杖和相關資訊。例如:

{
  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOimYyD8IP2IyYS1jNmNiLTQ4NTgtYjZkMS1mZjkyNGFkYTk1YWUiLCJzdWIiOiI0X0KLSNjZlNjM0ZC0zZjlhLTRiNYmFjNi1kYjE2M2M5OGEzOGYiLCJzY29wZSI6WyJzYbmlkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJvYXV0aC5hcHByb3ZhbHMiXSwiY2xpZW50X2lkIjoiZWRnZWNsaSIsImNpZCI6ImVkZ2VjbGkiLCJhenAiOiJlZGdlY2xpIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwidXNlcl9pZCI6IjQ2NmU2MzRkLTNmOWEtNGI0MS1iYWM2LWRiMTYzYzk4YTM4ZiIsIm9yaWdpbiI6InVzZXJncmlkIiwidXNlcl9uYW1lIjoid3dpdG1hbkBhcGlnZWUuY29tIiwiZW1haWwiOiJ3d2l0bWFuQGFwaWdlZS5jb20iLCJhdXRoX3RpbWUiOjE0NzMyNjU4NzcsImFsIjoyLCJyZXZfc2lnIjoiZTc0ZGY0M2QiLCJpYXQiOjE0NzMyNjU4NzcsImV4cCI6MTQ3MzI2NzY3NywiaXNzIjoiaHR0cHM6Ly9sb2dpbi5hcGlnZWUuY29tL29hdXRoL3Rva2VuIiwiemlkIjoidWFhIiwi2ltLm1lIiwib3BlYXVkIjpbImVkZ2VjbGkiLCJzY2ltIiwib3BlbmlkIiwicGFzc3dvcmQiLCJhcHByb3ZhbHMiLCJvYXV0aCJdfQ.AFuevkeGGUGSPED8leyEKaT-xg1xk_VEiKJLEpipVvQBXIqEc9wqcpm-ZuoatA9DhjASRuFSRaHH8Fasx_vBxEBsUNhRY-GTMw7_8fv4yRMOb2AO3WUl_NWwPkC8XRSI1zCMbAZicojsJ1n3OSP487Mu9dl9ByX5A_QfHV2_cj4l9-SD7u6vOdfdbBxbNMAQkfZLrVIEU8myF2dhKnNeMiuoHSHANsQFcx0_BFA1HnSUnVi4RYj1FlTs9SbcPnS1d7t7eVdxWz_q2OFVXNIBMELAvvM0WhXPYTW3Osve3UvvUs6ekGs-K-RCPSok-4-NJbdCDpZQQTgqHsrf77NTsw",
  "token_type": "bearer",
  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJmZTIIMZWI0ZS00YzFmLTRjOTEtYmY5Mi1mMzZLEMzNjZhMDctciIsInN1YiI6IjQ2NmU2MzRkLTNmOWEtNGI0MS1iY17LLWRiMTYzYzk4YTM4ZiIsInNjb3BlIjpbInNjaW0ubWUiLCJvcGVuaWQiLCJwYXNzd29yZC53cml0ZSIsImFwcHJvdmFscy5tZSIsIm9hdXRoLmFwcHJvdmFscyJdLCJpYXQiOjE0NzMyNjU4NzcsImV4cCI6MTQ3NsaSIsImNsaWVudF9pZCI6ImVkZ2VjbGkiLCJpc3MiOiJodHRwczovL2xvZ2luLmFwaWdlZS5jb20vb2F1dGgvdG9rZW4iLCJ6aWQiOiJ1YWEiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiJ3d2l0bWFuQGFwaWdlZS5jbMzM1MDQ3NywiY2lkIjoiZWRnZW20iLCJvcmlnaW4iOiJ1c2VyZ3JpZCIsInVzZXJfaWQiOiI0NjZlNjM0ZC0zZjlhLTRiNDEtYmFjNi1kYjE2M2M5OGEzOGYiLCJhbCI6MiwicmV2X3NpZyI6ImU3NGRmNDNkIiwiYXVkIjpbImVkZ2VjbGkiLCJzY2ltIiwib3BlbmlkIiwicGFzc3dvcmQiLCJhcHByb3ZhbHMiLCJvYXV0aCJdfQ.kBP5AkbRS7Tnp-5VAfTLVfkUbUer4gFEU6A7g202KTKiXbqTwPSmOIGFTK12XevVPQYmAaSMFAnempWKfY7sjaY7HC7q3mGl53_A18cnkKhtNq15wCnyMom_bX_MYLW1RQPFytJ6akSJ-JkoPFU0x_FQg1JIvub1A8eqQxcR0KP-QRCxYAS4HTjH80vDIxHNt1tg7clmpa3RlHri0dlPVVsSpTXXhkpXRg5QbiWMrpkACSV22c0x0KiNu7vx5A520VOCO7hQ7IzmVIcSWcRqI97L7WdCjH_q4105bs2qmW73670MC0UGiJ9t5B1S1cxwqpUEd-NAuCsY8SVn6eWzbA",
  "expires_in": 1799,
  "scope": "scim.me openid password.write approvals.me oauth.approvals",
  "jti": "9bf2cb2a-c6cb-4858-b6d1-ff924ada95ae"
}

儲存回應值:

  • 在對 Edge API 的呼叫中使用 access_token
  • 請在存取權杖過期後使用 refresh_token, 重新整理

如果收到類似以下的回應:

{
  "error": "unauthorized",
  "error_description": "Bad credentials"
}

請確定您使用的是上方提供的字串 (「ZWRnZWNsaTplZGdlY2xpc2VjcmV0」), 要求中的 Authorization 標頭。