Zum Hauptinhalt springen

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.

Bevor Sie einen externen Identitätsanbieter für Ihren Mandanten verwenden, testen Sie Ihre Parameter, um zu überprüfen, ob sich Vantage darüber authentifizieren kann.

Einen externen Identitätsanbieter testen

1

Öffnen Sie die test-challenge-URL in Ihrem Browser

Verwenden Sie das zu Ihrem Protokoll passende URL-Format und füllen Sie die Parameter aus der unten stehenden Parameter-Referenz ein. Vollständige Beispiele finden Sie unter Beispiellinks.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

Authentifizieren Sie sich beim externen Identitätsanbieter

Geben Sie Ihre Anmeldedaten auf der Anmeldeseite des Identitätsanbieters ein.
3

Überprüfen Sie das Ergebnis

Es gibt drei mögliche Ergebnisse:
  • Erfolg mit returnUrl — Vantage leitet Sie an die in returnUrl angegebene URL weiter. In der Adressleiste werden der Benutzername und die E-Mail-Adresse des authentifizierten Benutzers angezeigt.
  • Erfolg ohne returnUrl — Vantage leitet Sie zurück zu der Seite, von der aus Sie den Testlink geöffnet haben.
  • Fehler — Auf der Anmeldeseite des Identitätsanbieters wird ein Authentifizierungsfehler angezeigt. Überprüfen Sie Ihre Parameter und führen Sie den Test erneut aus.

Parameter

ParameterErforderlich fürBeschreibung
settingsOAuth 2.0, SAML 2.0JSON zur Beschreibung des externen Identitätsanbieters. Die Struktur variiert je nach Protokoll — siehe unten.
returnUrlOAuth 2.0, SAML 2.0Die URL, zu der Vantage nach einem erfolgreichen Test weiterleitet. Verwenden Sie zum Testen einen beliebigen Vantage-Endpunkt wie /skills. Die Stamm-URL wird automatisch ergänzt.
tenantIdnur SAML 2.0Die Vantage-Mandanten-ID, die für die Authentifizierung verwendet wird.

settings für OAuth 2.0

FeldBeschreibung
KindAzureActiveDirectoryOidc oder OnPremiseActiveDirectoryOidc
Settings.AuthorityURL des externen Identitätsanbieters
Settings.ClientIdClient-ID des Identitätsanbieters
Beispiel:
{
  "Kind": "AzureActiveDirectoryOidc",
  "Settings": {
    "Authority": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888",
    "ClientId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
  }
}

settings für SAML 2.0

FeldBeschreibung
KindSaml2
Settings.MetadataUriURL des Föderationsmetadaten-Dokuments
Settings.OwnEntityIdAnwendungs-ID-URI in der Form api://<appId>
Beispiel:
{
  "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"
  }
}

Einrichten eines externen Identitätsanbieters

Überblick über die Einrichtung von OAuth 2.0- und SAML 2.0-Providern

Einrichten eines externen Identitätsanbieters für einen Mandanten

Wenden Sie den externen Identitätsanbieter auf Ihren Mandanten an

Konfigurieren eines OAuth 2.0-externen Identitätsanbieters

AD FS oder Azure AD mit OAuth 2.0

Konfigurieren eines SAML 2.0-externen Identitätsanbieters

AD FS oder Azure AD mit SAML 2.0