Skip to main content
Before setting up an External Identity Provider to be used by a tenant, check whether the specified parameters of the External Identity Provider are correct. To test external authentication via Vantage API, do the following depending on the protocol you use:
  1. Depending on the protocol you use, open the following link with the parameters described in the table below:
    • 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>

​
Parameters

ParameterProtocolDescription
settingsOAuth 2.0External Identity Provider authentication settings in JSON format. Contains the External Identity Provider type (the Kind parameter, can have the AzureActiveDirectoryOidc or OnPremiseActiveDirectoryOidc values), External Identity Provider URL (the Authority parameter), and Client ID (the ClientId parameter).

For example:
{"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3","ClientId":"4e674698-09b8-4ac5-8df7-35d6f0c1e36c"}}
settingsSAML 2.0External Identity Provider authentication settings in JSON format. Contains the External Identity Provider type and the External Identity Provider URL.

For example:
{"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3/federationmetadata/2007-06/federationmetadata.xml"}}
returnUrlOAuth 2.0 or SAML 2.0The URL that will be navigated to once authentication is complete. For testing purposes, specify any Vantage endpoint like /skills. The URL root is automatically embedded in the link used for authorization.
tenantIdSAML 2.0The tenant identifier to be used for authentication via a SAML 2.0 External Identity Provider.
  1. Enter your External Identity Provider credentials.
  2. After successfully completing the authentication procedure, you are redirected to either the page from which you sent the request or to the page specified in the returnUrl parameter. In the latter case, the address bar on the page will contain information about the authenticated user: username and email. If the entered parameters are incorrect, an authentication error displays on the page of the External Identity Provider. If this is the case, make sure that the settings are correct and repeat the test a second time after making the appropriate changes.