跳轉到主要內容
在為租戶設定要使用的外部身分識別提供者之前，請先檢查該外部身分識別提供者所指定的參數是否正確。 若要透過 Vantage API 測試外部驗證，請依您使用的通訊協定採取下列步驟：
  1. 依您使用的通訊協定，開啟下列連結，並附上下表所述的參數：
    • OAuth 2.0： https://<your-vantage-url>/api/v1/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>
    • SAML 2.0： https://<your-vantage-url>/api/v1/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>&tenantId=<tenantId>

​
參數

ParameterProtocolDescription
settingsOAuth 2.0以 JSON 格式提供的外部身分識別提供者驗證設定。包含外部身分識別提供者類型（Kind 參數，其值可為 AzureActiveDirectoryOidc 或 OnPremiseActiveDirectoryOidc）、外部身分識別提供者 URL（Authority 參數），以及用戶端 ID（ClientId 參數）。

例如：
{"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3","ClientId":"4e674698-09b8-4ac5-8df7-35d6f0c1e36c"}}
settingsSAML 2.0以 JSON 格式提供的外部身分識別提供者驗證設定。包含外部身分識別提供者類型、外部身分識別提供者 URL，以及應用程式 ID URI（作為 OwnEntityId）。

例如：
{"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3/federationmetadata/2007-06/federationmetadata.xml","OwnEntityId":"api://a37892f6-c2e9-4092-b804-d054741da4da"}}
returnUrlOAuth 2.0 or SAML 2.0驗證完成後將導向的 URL。作為測試用途，可指定任一 Vantage 端點，例如 /skills。URL 的根路徑會自動包含在用於授權的連結中。
tenantIdSAML 2.0透過 SAML 2.0 外部身分識別提供者進行驗證時所使用的租戶識別碼。
https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3","ClientId":"4e674698-09b8-4ac5-8df7-35d6f0c1e36c"}}&returnUrl=/skills

https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3/federationmetadata/2007-06/federationmetadata.xml","OwnEntityId":"api://a37892f6-c2e9-4092-b804-d054741da4da"}}&returnUrl=/skills&tenantId=your_vantage_tenant_id
  1. 輸入您的外部身分識別提供者認證資訊。
  2. 成功完成驗證流程後，系統會將您重新導向至發出請求的頁面，或是 returnUrl 參數中指定的頁面。在後一種情況下，該頁面的網址列會包含已通過驗證使用者的相關資訊：使用者名稱與電子郵件地址。若輸入的參數不正確，則會在外部身分識別提供者的頁面上顯示驗證錯誤。若發生此情況，請確認設定是否正確，進行適當修改後再執行一次測試。