跳轉到主要內容
在 Vantage 中,您可以建立、設定及刪除 Vantage Public API Client。

在租戶中建立第一個 Public API 用戶端

若要建立 Public API 用戶端,請依照下列步驟:
  1. 在 Vantage 中,按一下 Configuration
  2. Tenant Adminstration 對話方塊中,按一下 Create API Client
Create API Client Client Created 對話方塊中,會顯示您的 Client IDClient Secret Client ID and Secret Dialog
  1. 若要複製每個值,按一下每個值旁邊的 copy icon 或者,按一下 Save to File,以下載包含這兩個值的 TXT 檔案
重要! Secret 值只會在建立用戶端時顯示一次,因此必須立即儲存。
  1. 按一下 Close
    隨即顯示 Public API Client 頁面。

建立其他 Public API 用戶端

若要建立其他 Public API 用戶端,請依照下列步驟操作:
  1. 在 Vantage 中,按一下 Configuration
  2. Tenant Adminstration 對話方塊中,按一下 Public API Client
  3. Public API Client 頁面上,按一下 New Client 下拉清單,然後按一下 Add Client
New Client 下拉選單 Client Created 對話方塊中,會顯示您的 Client IDClient Secret
  1. 若要複製各個值,按一下其旁邊的 複製圖示 或者,按一下 Save to File 下載包含兩個值的 TXT 檔案
重要! Client Secret 值只會在用戶端建立時顯示一次,因此必須立即儲存。
  1. 按一下 Close
    隨即顯示 Public API Client 頁面。

設定 Public API Client

建立 public API client 之後,您需要對其進行設定。 若要編輯 public API client 設定,請按一下用戶端名稱,或依用戶端名稱或 application principal 角色搜尋。 若要設定 public API client,請依下列步驟操作:
  1. Client Name 欄位中,輸入新的 public API client 名稱。
OAuth 2.0 設定
  1. 若要建立新的 secret,請按一下 Add Secret。預設情況下,secret 的有效期間為 6 個月。您可以變更有效期限,最長可設定為 36 個月。
  2. 若要新增重新導向 URL,請按一下 Add Redirect URL
  3. OAuth 2.0 Flows Settings 區段中,設定允許的驗證流程。
    注意: 當已設定 External Identity Provider 時,此流程無法運作。
    您可以選取一種以上的流程:
    • Allow Authorization Code Flow。允許使用這種安全的驗證機制進行驗證,其中應用程式不是將驗證要求導向使用者,而是直接傳送至 Vantage 授權伺服器。授權伺服器隨後驗證使用者的認證,並向用戶端提供授權碼。Authorization Code Flow 會為所有 Vantage API client 啟用。如有需要:
      • 選取 Require PKCE for Authorization Code Flow 選項。此選項可在授權 public client 時加強安全性,讓 Vantage 能驗證要求存取權杖的應用程式與啟動驗證的應用程式為同一個。
    • Allow Resource Owner Password Credentials Flow。允許使用者使用其使用者名稱與密碼進行驗證。這表示應用程式可以存取使用者的密碼,因此在使用者與應用程式之間必須具有高度信任。
    • 選取 Allow issuing refresh tokens to refresh access tokens。此選項允許簽發 refresh tokens 以取得更新後的 access tokens。應用程式可以使用這些 refresh tokens 要求新的 access tokens,而不需與使用者互動。應用程式必須安全儲存 refresh tokens,因為它們可讓使用者維持已驗證狀態。
  4. Allow client credentials flow。允許應用程式使用 OAuth 2.0 Client Credentials flow 進行授權,從而存取 Vantage API。指派給應用程式的角色由 Allow client credentials flow 下方的 Manage Roles 設定決定。依據指定的角色,應用程式將登入 Vantage。
  5. 設定 Token Lifetime Settings
    • Access Token。 定義已簽發的 access token 允許使用者存取 Vantage 的時間長度。access token 的預設有效期間為 24 小時。
    • Refresh Token。 定義自首次簽發 access token 起算的絕對期間,在此期間內,已簽發的 refresh token 可用來更新 access token。refresh token 的預設有效期間為 30 天。
如需關於驗證流程的詳細資訊,請參閱驗證

刪除 Public API 用戶端

若要刪除用戶端,按一下圖示,然後按一下 Delete Client Delete Client