Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Avant d’appliquer un fournisseur d’identité externe à votre tenant, testez vos paramètres pour vérifier que Vantage peut s’authentifier par son intermédiaire.

Tester un fournisseur d’identité externe

1

Ouvrez l’URL de test-challenge dans votre navigateur

Utilisez le modèle d’URL correspondant à votre protocole en renseignant les paramètres à partir de la référence Paramètres ci-dessous. Pour des exemples complets, voir Exemples de liens.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

Authentifiez-vous auprès du fournisseur d’identité externe

Saisissez vos identifiants sur la page de connexion du fournisseur d’identité.
3

Vérifiez le résultat

L’un des trois résultats suivants se produit :
  • Succès avec un returnUrl — Vantage vous redirige vers l’URL indiquée dans returnUrl. La barre d’adresse affiche le nom d’utilisateur et l’adresse e-mail de l’utilisateur authentifié.
  • Succès sans returnUrl — Vantage vous redirige vers la page à partir de laquelle vous avez ouvert le lien de test.
  • Échec — Une erreur d’authentification s’affiche sur la page de connexion du fournisseur d’identité. Vérifiez vos paramètres et exécutez de nouveau le test.

Paramètres

ParamètreRequis pourDescription
settingsOAuth 2.0, SAML 2.0JSON décrivant le fournisseur d’identité externe. La structure varie selon le protocole — voir ci-dessous.
returnUrlOAuth 2.0, SAML 2.0URL vers laquelle Vantage redirige après un test réussi. Pour les tests, utilisez n’importe quel endpoint Vantage, comme /skills. La racine de l’URL est ajoutée automatiquement.
tenantIdSAML 2.0 uniquementIdentifiant du tenant Vantage utilisé pour l’authentification.

settings pour OAuth 2.0

ChampDescription
KindAzureActiveDirectoryOidc ou OnPremiseActiveDirectoryOidc
Settings.AuthorityURL du fournisseur d’identité externe
Settings.ClientIdIdentifiant client du fournisseur d’identité
Exemple :
{
  "Kind": "AzureActiveDirectoryOidc",
  "Settings": {
    "Authority": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888",
    "ClientId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
  }
}

settings pour SAML 2.0

ChampDescription
KindSaml2
Settings.MetadataUriURL du document de métadonnées de fédération
Settings.OwnEntityIdURI d’ID de l’application sous la forme api://<appId>
Exemple :
{
  "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"
  }
}
https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888","ClientId":"aaaabbbb-0000-cccc-1111-dddd2222eeee"}}&returnUrl=/skills
https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"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"}}&returnUrl=/skills&tenantId=your_vantage_tenant_id

Mise en place d’un fournisseur d’identité externe

Présentation de la configuration des fournisseurs OAuth 2.0 et SAML 2.0

Mise en place d’un fournisseur d’identité externe pour un tenant

Appliquez ce fournisseur d’identité externe à votre tenant

Configuration d’un fournisseur d’identité externe OAuth 2.0

AD FS ou Azure AD avec OAuth 2.0

Configuration d’un fournisseur d’identité externe SAML 2.0

AD FS ou Azure AD avec SAML 2.0