跳转到主要内容
在为租户配置要使用的外部身份提供程序之前,请先检查该外部身份提供程序的指定参数是否正确。 要通过 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>

参数

Parameter协议描述
settingsOAuth 2.0JSON 格式的外部身份提供程序身份验证设置。包含外部身份提供程序类型(Kind 参数,可取 AzureActiveDirectoryOidcOnPremiseActiveDirectoryOidc 值)、外部身份提供程序 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.0JSON 格式的外部身份提供程序身份验证设置。包含外部身份提供程序类型、外部身份提供程序 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 参数中指定的页面。在后一种情况下,页面地址栏中将包含有关已通过身份验证用户的信息:用户名和电子邮箱。如果输入的参数不正确,外部身份提供者的页面上会显示身份验证错误。在这种情况下,请确保设置正确,并在进行相应更改后再次进行测试。