Icertis-Authentifizierung

Dieser Connector unterstützt zwei Authentifizierungstypen:

• OAuth 2.0: Autorisierungscode (Standard)

• API-Schlüssel

OAuth 2.0: Autorisierungscode

Der OAuth 2.0-Autorisierungscode ist der Standardauthentifizierungstyp für den Icertis-Connector. Es basiert auf der Einrichtung einer OAuth 2.0-Anwendung in Microsoft Azure.

Voraussetzungen

Für die Verwendung der OAuth 2.0-Autorisierungscode-Authentifizierung benötigen Sie:

• Eine gültige Lizenz oder ein Abonnement für die Icertis Contract Intelligence (ICI)-Plattform.
• Eine gültige Lizenz oder ein Abonnement für Microsoft Azure.

Autorisierungsflow

Die Authentifizierungsmethode OAuth 2.0-Autorisierungscode verwendet den folgenden Autorisierungsablauf:

1. Die Clientanwendung fordert ein JWT-Zugriffstoken für die ICI-API vom Azure-Autorisierungsserver an.

2. Der Azure-Tokenausgabe-Endpunkt überprüft die Anmeldeinformationen und stellt das JWT-Zugriffstoken für die ICI-API aus.

3. Über HTTPS verwendet die Clientanwendung das zurückgegebene JWT-Zugriffstoken, um die JWT-Zeichenfolge mit einer Bearer -Bezeichnung im Autorisierungsheader der Anforderung an die ICI-API hinzuzufügen.

4. Der Token-Validierungs-Handler von ICI validiert das Zugriffstoken mit dem Azure-Autorisierungsserver.

5. Wenn die Tokenvalidierung erfolgreich ist, richtet ICI den Benutzerkontext basierend auf einem bestimmten Anspruchstypwert ein, der einem Benutzer im ICI-Repository zugeordnet ist, und gibt die gewünschte Ressource entsprechend zurück. Dieser Benutzer kann ein Dienst- oder ein Anwendungsbenutzer sein.

Konfigurieren einer Anwendung in Microsoft Azure

Führen Sie die folgenden Schritte aus, um eine ICI-Anwendung in Azure zu konfigurieren.

1. Melden Sie sich unter https://portal.azure.com/ beim Microsoft Azure-Portal an. Wählen Sie auf der Startseite die Option App-Registrierungen aus.
2. Wählen Sie auf der Seite App-Registrierungen die Option Neue Registrierung aus.
3. Geben Sie im Fenster Anwendung registrieren die folgenden Details für die neue App an:
   1. Name: ICM-API, zum Beispiel.
   2. Unterstützte Kontotypen: Wählen Sie Nur Konten in diesem Organisationsverzeichnis (Einzelner Mandant) aus.
   3. Geben Sie den folgenden Webumleitungs-URI an: https://cloud.uipath.com/provisioning_/callback
   4. Wählen Sie Registrieren aus. Die neue Anwendung ist jetzt auf der Registerkarte App-Registrierung – Eigene Anwendungen verfügbar.
      
      

      

      
      
4. Wählen Sie Ihre App auf der Seite App-Registrierungen aus. Der Abschnitt Verwalten enthält Registerkarten wie Authentifizierung, Zertifikate und Geheimschlüssel, API-Berechtigungen usw. Sie können die Anwendung mithilfe dieser Abschnitte weiter konfigurieren.
5. Auf der Registerkarte Authentifizierung können Sie einen neuen Umleitungs-URI hinzufügen oder den vorhandenen bearbeiten. Wählen Sie unter Implizite Gewährung die Option Zugriffstoken aus. Dadurch wird der Ablauf der impliziten Gewährung aktiviert und der Tokentyp ausgewählt, der vom Autorisierungstoken ausgestellt werden soll.
6. Wählen Sie als Nächstes unter Zertifikate und Geheimschlüssel die Option Neuer geheimer Clientschlüssel aus. Fügen Sie im neuen Fenster die Beschreibung des geheimen Clientschlüssels hinzu (z. B. „ICM-API-Geheimschlüssel, der für Zugriffstoken verwendet wird“) und wählen Sie das Ablaufdatum (z. B. ein Jahr) aus. Wählen Sie Hinzufügen aus, um das neue Geheimnis zu erstellen.

   Kopieren Sie den geheimen Clientschlüssel. Geben Sie diesen geheimen Schlüssel nicht öffentlich frei, und speichern Sie ihn an einem sicheren Ort. Sie können sie später nicht mehr abrufen.

7. Wählen Sie unter API verfügbar machen die Schaltfläche Festlegen neben Anwendungs-ID-URI aus. Ein Formular mit einem bereits generierten Standardwert wird angezeigt. Klicken Sie auf Speichern , um ihn zu speichern. Der Anwendungs-ID-URI verwendet das folgende Format: api://{Client ID}.
   
   

   

   
   
8. Ihre Azure-Anwendung ist jetzt mit Standard-Scopes und Gewährungstypen eingerichtet. Wenn Sie benutzerdefinierte Scopes hinzufügen möchten, wählen Sie unter API verfügbar machen die Option Scope hinzufügen aus. Konfigurieren Sie den neuen Scope und wählen Sie dann Scope hinzufügen aus.
   
   

   

   
   

Senden Sie die Anwendungsdetails an Icertis

Sobald Sie Ihre Anwendung erstellt haben, wenden Sie sich an Ihren Icertis-Administrator und geben Sie ihm die folgenden Details sowohl für Ihre Entwicklungs- als auch für Ihre Produktionsumgebung an:

Erforderliche App-Details	Details	Anmerkungen
Anwendungs-ID (Client).	Dev: [Kunde zur Verfügung zu stellen] Produktion: [Der Kunde muss bereitstellen]	Anwendungs-ID für die App, die für den Zugriff auf die ICI-APIs erstellt wurde
Verzeichnis-ID (Mandant)	Dev: [Kunde zur Verfügung zu stellen] Produktion: [Der Kunde muss bereitstellen]	Mandanten-ID für die App, die für den Zugriff auf die ICI-APIs erstellt wurde
Objekt-ID	Dev: [Kunde zur Verfügung zu stellen] Produktion: [Der Kunde muss bereitstellen]	Objekt-ID für die App, die für den Zugriff auf die ICI-APIs erstellt wurde
OpenID Connect-Metadatendokument	Dev: [Kunde zur Verfügung zu stellen] Produktion: [Der Kunde muss bereitstellen]	Metadatendokument-URL für die App, die für den Zugriff auf die ICI-APIs erstellt wurde

ICI-Konfiguration

In der ICI Platform benötigen Sie eine Mindestkonfiguration, um loszulegen.

Fügen Sie die folgenden Schlüssel in der tenant.json -Datei der ICI-Anwendung mithilfe Ihres Icertis-Entwicklerteams hinzu oder aktualisieren Sie sie:

Schlüssel	Wert	JSON-Wert
Core.API.OAuth.STSDiscoveryEndpoint	https://login.microsoftonline.com/{Directory (tenant) ID}/v2.0/.well-known/openid-configuration	{ "Id": "1033c3c0-6bf2-4a93-b813-c3ba42a199b3", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": "https://login.microsoftonline.com/{Directory (tenant) ID}/v2.0/.well-known/openid-configuration", "Description": "STS Discovery Endpoint URL", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.STSDiscoveryEndpoint" }
Core.API.OAuth.ValidAudiences	api://{Client ID}	{ "Id": "94c37b1b-2fb1-4f4e-a3de-6796279031e6", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": " api://{Client ID}", "Description": "Comma separated list of valid audiences", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ValidAudiences" }
Core.API.OAuth.ValidIssuer	https://sts.windows.net/{Directory (tenant) ID}/	{ "Id": "d469b34c-f89f-42bb-934a-7ee4ef298130", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": "https://sts.windows.net/{Directory (tenant) ID}/", "Description": "OAuth Token issuer", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ValidIssuer" }
Core.API.OAuth.ExternalUpnClaimUri	http://schemas.microsoft.com/identity/claims/objectidentifier	{ "Id": "1e783a54-b564-4748-a088-c04e8e05ab46", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089”, "Value":"http://schemas.microsoft.com/identity/claims/objectidentifier", "Description": "URL of the Claim to be used to uniquely identify user in ICI", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ExternalUpnClaimUri" }

Wo:

• Core.API.OAuth.STSDiscoveryEndpoint ist der Wert des OpenID Connect-Metadatendokuments, der in App-Registrierung > Übersicht > Endpunkte zu finden ist.
  
  

  

  
  
• Core.API.OAuth.ValidAudiences ist der Anwendungs-ID-URI, der in App-Registrierung > Übersicht zu finden ist.
• Core.API.OAuth.ValidIssuer ist der Standardanforderungswert, der sich aus der Kombination des iss URL und der Verzeichnis-ID (Mandanten) ergibt. Die iss URL ist https://sts.windows.net und die Verzeichnis-(Mandanten-)ID ist unter App-Registrierung > Übersicht verfügbar.
  
  

  

  
  
• Core.API.OAuth.ExternalUpnClaimUri ist die Standard-Anspruchs-URL. ICI verwendet den Anspruchstyp oid mit der folgenden URL: http://schemas.microsoft.com/identity/claims/objectidentifier.

Sobald das Setup auf ICI-Ebene bereit ist, können Sie die ICI-API mit dem von Azure empfangenen Zugriffstoken testen. Beachten Sie, dass ICI nur die Zugriffstoken von Benutzern autorisiert, die in ICI bereitgestellt sind.

API-Schlüssel

Die API-Schlüsselauthentifizierungsmethode verwendet ein ICMAuthToken, um eine Verbindung zu erstellen. Verwenden Sie diese Authentifizierungsmethode, um schnell zu überprüfen, ob die APIs korrekt gehostet werden.

Das ICMAuthToken wird für einen angemeldeten Benutzer der Icertis Contract Intelligence (ICI) Platform generiert. Beachten Sie, dass Sie explizit ein Token-Ablaufdatum für einen Benutzer einrichten können.

1. Rufen Sie als ICI-Benutzer den API-Schlüssel ab, indem Sie zur folgenden URL navigieren: https://{{customerinstance}}.icertis.com/userinformation/GetUserApiToken.
2. Verwenden Sie die Entwicklertools Ihres Browsers, um die Seite zu überprüfen und das UserApiToken abzurufen.

Fügen Sie die Icertis-Verbindung hinzu

1. Wählen Sie Integration Service in der Automation Cloud^TM aus.

2. Wählen Sie in der Liste Connectors die Option Icertis aus. Sie können auch die Suchleiste verwenden, um den Connector einzugrenzen.
3. Wählen Sie die Schaltfläche Mit Icertis verbinden aus . Sie können zwischen zwei Authentifizierungstypen wählen: OAuth 2.0-Autorisierungscode oder API-Schlüssel.
4. Geben Sie die erforderlichen Anmeldeinformationen für Ihre bevorzugte Authentifizierung ein:
   1. OAuth 2.0: Autorisierungscode (Standard): Client-ID, geheimer Clientschlüssel, Mandanten-ID, Scope.
   2. API-Schlüssel: API-Schlüssel.
5. Wählen Sie Verbinden aus.