Saltar al contenido 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.

Antes de aplicar un proveedor de identidad externo a su tenant, pruebe los parámetros para confirmar que Vantage puede autenticarse a través de él.

​
Probar un proveedor de identidad externo

1

Abra la URL de test-challenge en su navegador

Use el formato de URL correspondiente a su protocolo y rellene los parámetros según la referencia de Parámetros que aparece a continuación. Para ver ejemplos completos, consulte Enlaces de ejemplo.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

Autentíquese con el proveedor de identidad externo

Introduzca sus credenciales en la página de inicio de sesión del proveedor de identidad.
3

Compruebe el resultado

Ocurrirá una de estas tres cosas:
  • Éxito con un returnUrl — Vantage le redirige a la URL especificada en returnUrl. La barra de direcciones muestra el nombre de usuario y el correo electrónico del usuario autenticado.
  • Éxito sin un returnUrl — Vantage le redirige a la página desde la que abrió el enlace de prueba.
  • Error — Aparece un error de autenticación en la página de inicio de sesión del proveedor de identidad. Compruebe sus parámetros y vuelva a realizar la prueba.

​
Parámetros

ParámetroRequerido paraDescripción
settingsOAuth 2.0, SAML 2.0JSON que describe el proveedor de identidad externo. La estructura varía según el protocolo; consulte a continuación.
returnUrlOAuth 2.0, SAML 2.0La URL a la que Vantage redirige después de una prueba exitosa. Para las pruebas, use cualquier endpoint de Vantage, como /skills. La raíz de la URL se agrega automáticamente.
tenantIdSolo SAML 2.0El identificador del tenant de Vantage utilizado para la autenticación.

​
settings para OAuth 2.0

CampoDescripción
KindAzureActiveDirectoryOidc o OnPremiseActiveDirectoryOidc
Settings.AuthorityURL del proveedor de identidad externo
Settings.ClientIdIdentificador de cliente del proveedor de identidad
Ejemplo: 
{
  "Kind": "AzureActiveDirectoryOidc",
  "Settings": {
    "Authority": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888",
    "ClientId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
  }
}

​
settings para SAML 2.0

CampoDescripción
KindSaml2
Settings.MetadataUriURL del documento de metadatos de la federación
Settings.OwnEntityIdURI del ID de la aplicación con el formato api://<appId>
Ejemplo: 
{
  "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

Configurar un proveedor de identidad externo

Descripción general de la configuración de los proveedores OAuth 2.0 y SAML 2.0

Configurar un proveedor de identidad externo para un tenant

Aplique el proveedor de identidad externo a su tenant

Configurar un proveedor de identidad externo OAuth 2.0

AD FS o Azure AD con OAuth 2.0

Configurar un proveedor de identidad externo SAML 2.0

AD FS o Azure AD con SAML 2.0