Richten Sie die Docusign eSignature-Spoke mit JWT-Gewährung ein

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 8 Minuten Lesedauer

    • Integrieren Sie die Instanz ServiceNow und DocuSign, indem Sie JWT-Gewährung verwenden, um ServiceNow -Anforderungen zu authentifizieren.

    Vorbereitungen

    • Fordern Sie ein IntegrationHub -Abonnement an.
    • Aktivieren Sie die Docusign eSignature-Spoke.
    • Erforderliche Rolle: admin.
    Wichtig:
    Wenn Sie die Docusign eSignature-Spoke mit JWT-Gewährung einrichten, müssen Sie die Spoke nicht mit Autorisierungscode-Gewährung einrichten.

    Konfigurieren Sie das Docusign-Konto

    Erstellen Sie eine anwenderdefinierte OAuth-Anwendung von Ihrem Docusign-Account, um die OAuth 2.0-Authentifizierung mit Docusign eSignature-Spoke zu aktivieren.

    Vorbereitungen

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

    Warum und wann dieser Vorgang ausgeführt wird

    Führen Sie diese Schritte von Ihrem Docusign-Konto aus. Anweisungen zum Erstellen und Konfigurieren von anwenderdefinierten Anwendungen finden Sie in der Dokumentation zum Docusign Developer Center. 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 ist, und Dokumentdaten im Flow verwenden.

    Prozedur

    1. Registrieren Sie Ihre Anwendung von Ihrem Docusign-Konto aus.
    2. Generieren Sie einen Integrationsschlü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 Instanz ServiceNow zu registrieren.
      Sie benötigen diese Werte, wenn Sie Registrieren Sie DocuSign als OAuth-Anbieter
    4. Klicken Sie auf RSA-SCHLÜSSELPAAR HINZUFÜGEN, und erfassen 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 und Integrationsschlüsseldie erforderliche 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-Callback-Endpunkt in diesem Format hinzu: https://.<instance> .service-now.com/oauth_redirect.do
        Fügen Sie dem Docusign-Konto einen Umleitungs-URI hinzu.
    6. Rufen Sie den Wert des Kontobasis-URI aus dem Docusign-Konto ab.
      1. Navigieren zu Integrationen > App und Schlüssel.
      2. Unter „Meine Kontoinformationen“ finden Sie den Wert des Kontobasis-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: Administrator

    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 mit der DocuSign-Integrator-App generiert haben.
      Weitere Informationen finden Sie unter Konfigurieren Sie das Docusign-Konto.
      Hinweis:
      Stellen Sie sicher, dass Sie sowohl den Anfang als auch das 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 ein CA-signiertes Zertifikat mit Ihrem privaten Schlüssel, 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 Ihrem CA-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 zur Eingabe eines Passworts auf.
    9. Geben Sie das Exportpasswort an.
    10. Erstellen Sie die JKS-Datei, indem Sie den folgenden Befehl ausführen: 
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
      Das System fordert Sie zur Eingabe eines Passworts auf.
    11. Geben Sie die Passwörter für Ziel- und Quell-Schlüsselspeicher an.

    Fügen Sie ein Java Key Store-Zertifikat an an Docusign eSignature-Spoke

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

    Vorbereitungen

    • Stellen Sie die Verfügbarkeit eines gültigen Java KeyStore-Zertifikats sicher
    • Erforderliche Rolle: Administrator

    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 der eine Benachrichtigung gesendet werden soll, bevor das Zertifikat abläuft.
      Aktiv Aktivieren
      Typ Wählen Sie Java Key Storeaus.
      Läuft in Tagen ab Geben Sie die Anzahl der Tage ein, bis das Zertifikat abläuft.
      Schlüsselspeicher-Passwort Geben Sie ein Passwort ein, das dem Zertifikat zugeordnet ist.
      Kurzbeschreibung Geben Sie eine Zusammenfassung des Zertifikats 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-Signaturschlüssel für die Docusign eSignature-Spoke

    Erstellen Sie einen JSON Web Token (JWT)-Signaturschlüssel, 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. Formularfelder „JWT-Schlüssel“.
      Feld Beschreibung
      Name Geben Sie einen Namen ein, um den JWT-Signaturschlü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 zu identifizieren, welcher Schlüssel verwendet wird, wenn mehrere Schlüssel zum Signieren von Token verwendet werden.
      Signaturalgorithmus Wählen Sie einen Algorithmus aus, der mit dem JWT-Schlüssel signiert werden soll.
      Signaturschlüssel-Passwort Geben Sie ein Passwort ein, das dem Signaturschlüssel zugeordnet ist.
      Aktiv Aktivieren Sie.
    4. Klicken Sie auf Absenden.

    Erstellen Sie einen JWT-Provider für den Docusign eSignature-Spoke

    Fügen Sie Ihrer ServiceNow-Instanz einen JSON-Web-Token-Provider (JWT) 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. Formularfelder des JWT-Providers
      Feld Beschreibung
      Name Geben Sie einen-Namen ein, um den JWT-Anbieter eindeutig zu identifizieren. Beispiel: DocuSign-JWT-Anbieter.
      Ablaufintervall (Sek.) Geben Sie eine Zahl in Sekunden ein, um die lifespan von JWT-Provider -[]- Tokenfestzulegen.
      Signierkonfiguration Wählen Sie einen JWT-Signaturschlü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 Anwenderdefinierte Ansprüche werden angezeigt.
    5. Wählen Sie den JWT-Provider aus, der für die Docusign eSignature-Spoke erstellt wurde.
    6. Geben Sie in der zugehörigen Liste „Standardansprüche“Werte für „iss“, „sub“ und „aud“ ein.
      Anweisungen finden Sie im Docusign Developer Center.
    7. Fügen Sie einen -Datensatz in die zugehörige Liste „Anwenderdefinierte Ansprüche“ ein, und füllen Sie das Formularaus.
      Tabelle : 4. Felder der zugehörigen Liste für anwenderdefinierte Ansprüche
      Feld Wert
      Anspruchname scope
      Anspruchwerttyp Zeichenfolge
      Anspruchwert Identitätswechsel zur Signatur
    8. Klicken Sie auf Aktualisieren.

    Registrieren Sie DocuSign als OAuth-Anbieter

    Verwenden Sie die Informationen, die während der Konfiguration des Docusign-Accounts 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.
      Das System zeigt die Meldung Welche Art von OAuth-Anwendung?
    3. Wählen Sie Verbindung zu einem fremden OAuth-Provider herstellen aus.
      Das System zeigt ein leeres Formular „Anwendungsregistrierungen“ an.
    4. Füllen Sie das Formular aus.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Datensatz eindeutig zu identifizieren. Geben Sie beispielsweise Docusign OAuthein.
      Client-ID Geben Sie den Integratorschlüssel ein, den Sie während der Konfiguration des Docusign-Kontos generiert haben.
      Geheimer Clientschlüssel Geben Sie den geheimen Clientschlüssel ein, den Sie während der Konfiguration des Docusign-Kontos generiert haben.
      Standardgewährungstyp Wählen Sie JWT Beareraus.
      Autorisierungs-URL
      • Geben Sie für die Entwickler-Sandbox-Umgebung https://account-d.docusign.com/oauth/authein.
      • Geben Sie für ein Live-Produktionssystem https://account.docusign.com/oauth/authein.
      Token-URL
    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ährungstyp als JWT Beareraus. Beispielsweise wird ein OAuth-Entitätsprofil mit dem Standardnamen„ Docusign OAuth 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. Felder der zugehörigen Liste „OAuth-Entitätsbereiche“.
      Feld Wert
      Name scope
      OAuth-Bereich Identitätswechsel zur Signatur
    7. Kopieren Sie den Wert aus der Umleitungs-URL.
    8. Klicken Sie auf Aktualisieren.
    9. Melden Sie sich bei Ihrem DocuSign-Konto an, um die Konfiguration Ihrer anwenderdefinierten DocuSign-Anwendung zu bearbeiten.
      Anweisungen finden Sie im Docusign Developer Center.
    10. Fügen Sie den Wert der Umleitungs-URL in den Umleitungs-URI für Ihre anwenderdefinierte 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 neu generiert wird, kann ein Administrator das OAuth-Spoke-Token neu generieren.

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

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

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Anmeldeinformationen.
    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.
      Im Popup-Fenster wird ein leeres Formular mit OAuth 2.0-Anmeldeinformationen angezeigt.
    4. Füllen Sie diese Werte aus.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Datensatz eindeutig 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 anwenderdefinierte DocuSign-Anwendung als OAuth-Anbieter registriert haben. Wählen Sie beispielsweise Docusign OAuth default_profileaus.
      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 sollen. Geben Sie z. B. 100 ein.
    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-Account. Der Alias für Verbindungen und Anmeldeinformationen der Docusign-Spoke nutzt 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. Öffnen Sie für den Datensatz für DocuSign.
    3. Klicken Sie auf der Registerkarte Verbindungen auf Neu.
      Das System zeigt ein leeres HTTP(s)-Verbindungsformular an.
    4. Geben Sie diese Werte ein.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Verbindungsdatensatz eindeutig zu identifizieren. Geben Sie beispielsweise Docusign-Verbindungein.
      Referenz Wählen Sie den Anmeldeinformationsdatensatz aus, den Sie für DocuSign erstellt haben. Wählen Sie beispielsweise Docusign-Anmeldeinformationenaus.
      Verbindungs-URL
      • Geben Sie für die Demo-Umgebung https://demo.docusign.netein.
      • Geben Sie für ein 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 Synchronisieren Sie Docusign mit ServiceNow.