Skip to main content
Before applying an External Identity Provider to your tenant, test your parameters to confirm Vantage can authenticate through it.

​
Test an External Identity Provider

1

Open the test-challenge URL in your browser

Use the URL shape that matches your protocol, filling in the parameters from the Parameters reference below. For fully composed examples, see Sample links.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>
2

Authenticate with the External Identity Provider

Enter your credentials on the Identity Provider’s sign-in page.
3

Check the result

One of three things happens:
  • Success with a returnUrl — Vantage redirects you to the URL specified in returnUrl. The address bar shows the authenticated user’s username and email.
  • Success without a returnUrl — Vantage redirects you back to the page you opened the test link from.
  • Failure — An authentication error appears on the Identity Provider’s sign-in page. Check your parameters and run the test again.

​
Parameters

ParameterRequired forDescription
settingsOAuth 2.0, SAML 2.0JSON describing the External Identity Provider. Shape varies by protocol — see below.
returnUrlOAuth 2.0, SAML 2.0The URL Vantage redirects to after a successful test. For testing, use any Vantage endpoint like /skills. The URL root is embedded automatically.
tenantIdSAML 2.0 onlyThe Vantage tenant identifier used for authentication.

​
settings for OAuth 2.0

FieldDescription
KindAzureActiveDirectoryOidc or OnPremiseActiveDirectoryOidc
Settings.AuthorityURL of the External Identity Provider
Settings.ClientIdClient ID of the Identity Provider
Example: 
{
  "Kind": "AzureActiveDirectoryOidc",
  "Settings": {
    "Authority": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888",
    "ClientId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
  }
}

​
settings for SAML 2.0

FieldDescription
KindSaml2
Settings.MetadataUriURL of the Federation Metadata document
Settings.OwnEntityIdApplication ID URI in the form api://<appId>
Example: 
{
  "Kind": "Saml2",
  "Settings": {
    "MetadataUri": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888/federationmetadata/2007-06/federationmetadata.xml",
    "OwnEntityId": "api://cccc3333-dddd-4444-eeee-5555ffff6666"
  }
}