Richten Sie die Spoke DocuSign mit JWT Grant ein

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 8 Minuten Lesedauer

    • Integrieren Sie die Instanz [ ServiceNow und DocuSign, indem Sie JWT Grant verwenden, um ServiceNow -Anforderungen zu authentifizieren.

    Vorbereitungen

    • Fordern Sie ein IntegrationHub -Abonnement an.
    • Aktivieren Sie DocuSign.
    • Erforderliche Rolle: admin
    Wichtig:
    Wenn Sie die DocuSign-Spoke mit JWT Grant einrichten, müssen Sie die Spoke nicht mit dem Autorisierungscode Grant einrichten.

    Konfigurieren Sie das DocuSign-Konto

    Erstellen Sie eine benutzerdefinierte OAuth-Anwendung von Ihrem DocuSign-Konto, um die OAuth 2.0-Authentifizierung mit DocuSign eSignature-Spoke zu aktivieren.

    Vorbereitungen

    DocuSign-Anforderungen:
    • DocuSign-Konto
    • DocuSign-App, die für die Integration mit konfiguriert ist ServiceNow
    • Erforderliche Rolle: DocuSign-Administrator

    Warum und wann dieser Vorgang ausgeführt wird

    Führen Sie diese Schritte in Ihrem DocuSign-Konto aus. In der Dokumentation zum DocuSign Developer Center finden Sie Anweisungen zum Erstellen und Konfigurieren benutzerdefinierter Anwendungen. DocuSign verwendet einen geskripteten Webhook, um signierte Dokumentdaten an die Instanz ServiceNow zu senden. Dadurch können Flow Designer einen Flow anhalten, bis ein Dokument signiert wird, und Dokumentdaten im Flow verwenden.

    Prozedur

    1. Registrieren Sie Ihre Anwendung in Ihrem DocuSign-Konto.
    2. Generieren Sie einen Integratorschlüssel und einen geheimen Schlüssel.
    3. Notieren Sie die Werte des Integrationsschlüssels und des geheimen Schlüssels, um die App als OAuth-Drittpartei in Ihrer ServiceNow -Instanz zu registrieren.
      Sie benötigen diese Werte, wenn Sie Registrieren Sie DocuSign als OAuth-Provider
    4. Klicken Sie auf RSA-SCHLÜSSELPAAR HINZUFÜGEN, und notieren Sie die Schlüsselpaar-ID, den öffentlichen Schlüsselund den privaten Schlüssel.
    5. Fügen Sie die OAuth-Umleitungs-URL ServiceNow in Ihrem DocuSign-Konto hinzu.
      1. Navigieren zu Integrationen > App und Schlüssel.
      2. Suchen Sie unter Apps and Integration Keys(Apps und Integrationsschlüssel) nach der erforderlichen App.
      3. Klicken Sie für die erforderliche App auf die Dropdown-Liste Aktionen, und klicken Sie auf Bearbeiten.
      4. Klicken Sie unter Zusätzliche Einstellungenauf URI hinzufügen, und fügen Sie den OAuth-Rückrufendpunkt in diesem Format hinzu: https://<instance> .service-now.com/oauth_redirect.do .
        Fügen Sie den Umleitungs-URI im DocuSign-Konto hinzu.
    6. Rufen Sie den Wert des Account-Basis-URI aus dem DocuSign-Account ab.
      1. Navigieren zu Integrationen > App und Schlüssel.
      2. Unter Meine Account-Informationenfinden Sie den Wert des Account-Basis-URI.
        Account-Basis-URI.
      3. Kopieren Sie diesen Wert, und notieren Sie ihn zur späteren Verwendung.

    Generieren Sie das JKS-Zertifikat

    Generieren Sie ein JKS-Zertifikat für die JWT-Authentifizierung von DocuSign eSignature-Spoke.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Öffnen Sie den Texteditor für Code, z. B. Erhabener Text.
    2. Erstellen Sie eine neue Datei.
    3. Fügen Sie den privaten Schlüssel ein, den Sie zuvor in Ihrer DocuSign-Integrations-App generiert haben.
      Weitere Informationen finden Sie unter Konfigurieren Sie das DocuSign-Konto.
      Hinweis:
      Stellen Sie sicher, dass Sie sowohl Anfang als auch Ende des privaten Schlüssels angeben.
    4. Speichern Sie die Datei mit der Erweiterung „.key“, z. B. privatekey.key.
    5. Öffnen Sie das Terminal, und navigieren Sie zu dem Verzeichnis, in dem Sie die Datei mit der Erweiterung „.key “ gespeichert haben.
    6. Erstellen Sie mit Ihrem privaten Schlüssel ein von der Zertifizierungsstelle signiertes Zertifikat, indem Sie den folgenden Befehl ausführen: 
      openssl req -new -x509 -key <file-name>.key -out <certificate-name>.pem -days 1095
      Das System fordert Sie auf, die erforderlichen Details wie Ländername, Provinzname usw. anzugeben.
    7. Geben Sie die erforderlichen Details ein.
    8. Erstellen Sie eine PKCS 12-Datei mit Ihrem privaten Schlüssel und dem von der Zertifizierungsstelle signierten Zertifikat, indem Sie den folgenden Befehl ausführen: 
      openssl pkcs12 -export -in <certificate-name>.pem -inkey <file-name>.key -certfile <certificate-name>.pem -out <PKCS-12-file-name>.p12
      Das System fordert Sie auf, ein Passwort einzugeben.
    9. Geben Sie das Exportpasswort an.
    10. Erstellen Sie die JKS-Datei, indem Sie diesen Befehl ausführen: 
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
      Das System fordert Sie auf, ein Passwort einzugeben.
    11. Geben Sie die Passwörter des Ziel- und Quellschlüsselspeichers an.

    Hängen Sie ein Java Key Store-Zertifikat an den an DocuSign eSignature-Spoke

    Aktivieren Sie die JWT Bearer Grant-Token-Authentifizierung, indem Sie ein gültiges JKS-Zertifikat (Java KeyStore) an DocuSign eSignature-Spokeanhängen.

    Vorbereitungen

    • Stellen Sie sicher, dass ein gültiges Java KeyStore-Zertifikat verfügbar ist
    • Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > Systemdefinition > Zertifikate.
    2. Klicken Sie auf Neu.
    3. Füllen Sie das Formular aus.
      Tabelle : 1. Formularfelder X.509-Zertifikat
      Feld Beschreibung
      Name Geben Sie einen Namen ein, um den Datensatz eindeutig zu identifizieren. Beispiel: DocuSign-Zertifikat.
      Benachrichtigung bei Ablauf Definieren Sie Benutzer, die benachrichtigt werden sollen, wenn das Zertifikat abläuft.
      Tage vor Ablauf benachrichtigen Geben Sie die Anzahl der Tage ein, nach denen eine Benachrichtigung gesendet werden soll, bevor das Zertifikat abläuft.
      Aktiv Aktivieren
      Typ Wählen Sie Java Key Store aus.
      Läuft in Tagen ab Geben Sie die Anzahl der Tage ein, bis das Zertifikat abläuft.
      Schlüsselspeicher-Passwort Geben Sie ein dem Zertifikat zugeordnetes Passwort ein.
      Kurzbeschreibung Geben Sie eine Zusammenfassung zum Zertifikat ein.
    4. Klicken Sie auf das Anhangsymbol ( Anhangsymbol), und hängen Sie ein JKS-Zertifikat an.
    5. Klicken Sie auf Speicher/Zertifikate validieren.

    Erstellen Sie einen JWT-Signierschlüssel für DocuSign eSignature-Spoke

    Erstellen Sie einen JWT-Signierschlüssel (JSON Web Token), um ihn Ihrem Java KeyStore-Zertifikat zuzuweisen.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > System-OAuth > JWT-Schlüssel.
    2. Klicken Sie auf Neu.
    3. Füllen Sie das Formular aus.
      Tabelle : 2. Felder des Formulars „JWT-Schlüssel“.
      Feld Beschreibung
      Name Geben Sie einen Namen ein, um den JWT-Signierschlüssel eindeutig zu identifizieren. Beispiel: DocuSign-JWT-Schlüssel.
      Signatur-Schlüsselspeicher Wählen Sie das gültige JKS-Zertifikat aus, das in der vorherigen Aufgabe angehängt wurde. Beispiel: DocuSign-Zertifikat.
      Schlüssel-ID Geben Sie eine Schlüssel-ID ein, um anzugeben, welcher Schlüssel verwendet wird, wenn mehrere Schlüssel zum Signieren von Token verwendet werden.
      Signaturalgorithmus Wählen Sie einen Algorithmus zum Signieren mit dem JWT-Schlüssel aus.
      Signaturschlüssel-Passwort Geben Sie ein Passwort ein, das dem Signaturschlüssel zugeordnet ist.
      Aktiv Aktivieren.
    4. Klicken Sie auf Absenden.

    Erstellen Sie einen JWT-Provider für DocuSign eSignature-Spoke

    Fügen Sie Ihrer ServiceNow-Instanz einen JSON Web Token (JWT)-Provider hinzu.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > System-OAuth > JWT-Anbieter.
    2. Klicken Sie auf Neu.
    3. Füllen Sie die Felder des Formulars aus.
      Tabelle : 3. Felder des Formulars „JWT-Provider“.
      Feld Beschreibung
      Name Geben Sie einen-Namen ein, um den JWT-Provider eindeutig zu identifizieren. Beispiel: DocuSign JWT Provider.
      Ablaufintervall (Sek.) Geben Sie eine Zahl in Sekunden ein, um die Spanne lvon JWT-Provider-Tokenfestzulegen.
      Signierkonfiguration Wählen Sie einen JWT-Signierschlüssel aus. Beispiel: DocuSign-JWT-Schlüssel.
    4. Klicken Sie mit der rechten Maustaste auf den Formularheader und wählen Sie Speichern aus.
      Die zugehörigen Listen „Standardansprüche“ und „Benutzerdefinierte Ansprüche“ werden angezeigt.
    5. Wählen Sie den JWT-Provider aus, der für die DocuSign-Spoke erstellt wurde.
    6. Geben Sie Werte für iss, subund aud in die zugehörige Liste Standardansprüche ein.
      Anweisungen finden Sie im DocuSign Developer Center.
    7. Fügen Sie einen -Datensatz in die zugehörige Liste „ Benutzerdefinierte Ansprüche “ ein, und füllen Sie das Formular aus.
      Tabelle : 4. Felder der zugehörigen Liste „Benutzerdefinierte Ansprüche“.
      Feld Wert
      Anspruchname scope
      Anspruchwerttyp Zeichenfolge
      Anspruchwert Identitätswechsel der Signatur
    8. Klicken Sie auf Aktualisieren.

    Registrieren Sie DocuSign als OAuth-Provider

    Verwenden Sie die Informationen, die während der Konfiguration des DocuSign-Kontos generiert wurden, um DocuSign als OAuth-Anbieter zu registrieren und der Instanz die Anforderung von OAuth 2.0-Token zu gestattet.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > System-OAuth > Applikationsregistrierung.
    2. Klicken Sie auf Neu.
      Die Meldung Welche Art von OAuth-Anwendung?wird angezeigt.
    3. Wählen Sie Verbindung zu einem fremden OAuth-Provider herstellen aus.
      Das System zeigt ein leeres Anwendungsregistrierungsformular an.
    4. Füllen Sie das Formular aus.
      Feld Wert erforderlich
      Name Geben Sie einen eindeutigen Namen ein, um den Datensatz zu identifizieren. Geben Sie beispielsweise DocuSign OAuthein.
      Client-ID Geben Sie den Integratorschlüssel ein, den Sie während der DocuSign-Kontokonfiguration generiert haben.
      Geheimer Clientschlüssel Geben Sie den geheimen Clientschlüssel ein, den Sie während der DocuSign-Kontokonfiguration generiert haben.
      Standardgewährungstyp Wählen Sie JWT Bearer aus.
      Autorisierungs-URL
      • Geben Sie für die Entwickler-Sandbox-Umgebung https://account-d.docusign.com/oauth/authein.
      • Geben Sie für das Live-Produktionssystem https://account.docusign.com/oauth/authein.
      Token-URL
      • Geben Sie für die Entwickler-Sandbox-Umgebung https://account-d.docusign.com/oauth/tokenein.
      • Geben Sie für das Live-Produktionssystem https://account.docusign.com/oauth/tokenein. Weitere Informationen finden Sie unter Endpunktreferenz für Post-Go-Live und Benutzerinformationen in der Dokumentation zum DocuSign Developer Center.
    5. Klicken Sie mit der rechten Maustaste auf den Formularheader und wählen Sie Speichern aus.
      • Das System validiert die OAuth-Anmeldeinformationen und füllt die Umleitungs-URLaus.
      • Das System füllt das OAuth-Entitätsprofil mit dem GewährungstypJWT Bearer. Zum Beispiel wird ein OAuth-Entitätsprofil mit dem Standardnamen DocuSignOAuth default_profile erstellt
    6. Fügen Sie einen Datensatz in die zugehörige Liste „OAuth-Entitätsbereiche“ ein, und füllen Sie die Werte aus.
      Tabelle : 5. Zugehörige Listenfelder für OAuth-Entitätsbereiche
      Feld Wert
      Name scope
      OAuth-Bereich Identitätswechsel der Signatur
    7. Kopieren Sie den Wert aus Redirect URL(Umleitungs-URL).
    8. Klicken Sie auf Aktualisieren.
    9. Melden Sie sich bei Ihrem DocuSign-Konto an, um die Konfiguration Ihrer benutzerdefinierten DocuSign-Anwendung zu bearbeiten.
      Anweisungen finden Sie im DocuSign Developer Center.
    10. Fügen Sie den Wert Redirect URL (Umleitungs-URL) in den Umleitungs-URI für Ihre benutzerdefinierte DocuSign-Anwendung ein.
      Fügen Sie beispielsweise https://instance.service-now.com/oauth_redirect.doein

    Ergebnisse

    Die Instanz kann OAuth 2.0-Token für die Spoke anfordern.
    Hinweis:
    Wenn ein OAuth-Token abläuft, generiert die Spoke in den meisten Fällen automatisch ein neues Token. Wenn ein Token abläuft und nicht erneut generiert wird, kann ein Administrator das Spoke-OAuth-Token erneut generieren.

    Erstellen Sie Anmeldeinformationsdatensätze für DocuSign eSignature-Spoke

    Erstellen Sie Datensätze für Anmeldeinformationen für die benutzerdefinierte DocuSign-OAuth-Anwendung, die Sie während der Konfiguration des DocuSign-Kontos erstellt haben. Der Alias für Verbindungen und Anmeldeinformationen der DocuSign-Spoke verwenden diese Anmeldeinformationen zum Autorisieren von Aktionen.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Berechtigungen.
    2. Klicken Sie auf Neu.
      Das System zeigt die Meldung Welche Art von Anmeldeinformationen möchten Sie erstellen? an..
    3. Wählen Sie OAuth 2.0-Anmeldeinformationen aus.
      Das Pop-up-Fenster zeigt ein leeres Formular für die OAuth 2.0-Anmeldeinformationen an.
    4. Füllen Sie diese Werte aus.
      Feld Wert erforderlich
      Name Geben Sie einen eindeutigen Namen ein, um den Datensatz zu identifizieren. Geben Sie beispielsweise DocuSign-Anmeldeinformationenein.
      Aktiv Aktivieren
      OAuth-Einheitenprofil Wählen Sie das OAuth-Profil aus, das Sie erstellt haben, als Sie die benutzerdefinierte DocuSign-Anwendung als OAuth-Provider registriert haben. Wählen Sie beispielsweise DocuSign OAuth default_profile aus.
      Betrifft Wählen Sie die MID Server aus, die diese Anmeldeinformationen verwenden können. Wählen Sie beispielsweise Alle MID Server aus.
      Reihenfolge Wählen Sie die Reihenfolge aus, in der diese Anmeldeinformationen angewendet werden. Geben Sie z. B. 100ein.
    5. Speichern Sie den Datensatz.
    6. Klicken Sie auf den zugehörigen Link OAuth-Token abrufen, um das OAuth-Token zu generieren.

    Erstellen Sie Verbindungsdatensätze für DocuSign eSignature-Spoke

    Erstellen Sie Verbindungsdatensätze für Ihr DocuSign-Konto. Der Alias für Verbindungen und Anmeldeinformationen der DocuSign-Spoke verwendet diese Verbindungen, um Aktionen in DocuSign auszuführen.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Aliasse für Verbindungen und Anmeldeinformationen.
    2. Für den Datensatz für DocuSign öffnen.
    3. Klicken Sie auf der Registerkarte Verbindungen auf Neu.
      Das System zeigt ein leeres HTTP(s)-Verbindungsformular an.
    4. Geben Sie die folgenden Werte ein.
      Feld Wert erforderlich
      Name Geben Sie einen eindeutigen Namen ein, um den Verbindungsdatensatz zu identifizieren. Geben Sie beispielsweise DocuSign-Verbindungein.
      Anmeldeinformation Wählen Sie den Anmeldeinformationsdatensatz aus, den Sie für DocuSign erstellt haben. Wählen Sie beispielsweise DocuSign-Anmeldeinformationen aus.
      Verbindungs-URL
      • Geben Sie für die Demoumgebung https://demo.docusign.netein.
      • Geben Sie für das Live-Produktionssystem den Basis-URI ein, z. B. na2.docusign.net oder eu.docusign.net. Anweisungen zum Abrufen des Basis-URI finden Sie unter Endpunktreferenz für Post-Go-Live und Benutzerinformationen in der Dokumentation zum DocuSign Developer Center.
    5. Klicken Sie auf Absenden.

    Nächste Maßnahme

    Synchronisieren Sie ServiceNow mit DocuSign, um über die DocuSign-Spoke auf DocuSign-Konten, -Vorlagen und -Umschläge zuzugreifen. Siehe DocuSign mit ServiceNow synchronisieren.