Configurer un spoke à l’aide de l’autorisation DocuSign JWT

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 9 minutes de lecture

    • Intégrez l’instance et DocuSign en utilisant l’autorisation ServiceNow JWT pour authentifier les ServiceNow demandes.

    Avant de commencer

    • Demandez un Hub d'intégration abonnement.
    • Activez DocuSign.
    • Rôle requis : admin
    Important :
    Si vous configurez un spoke DocuSign à l’aide de l’autorisation JWT, vous n’avez pas besoin de configurer le spoke à l’aide de l’autorisation d’attribution de code.

    Configurer le compte DocuSign

    Créez une application OAuth personnalisée à partir de votre compte DocuSign pour activer l'authentification OAuth 2.0 avec le Spoke DocuSign eSignature.

    Avant de commencer

    Conditions requises pour DocuSign :
    • Compte DocuSign
    • Application DocuSign configurée pour s’intégrer à ServiceNow
    • Rôle requis : administrateur DocuSign

    Pourquoi et quand exécuter cette tâche

    Effectuez ces étapes à partir de votre compte DocuSign. Consultez la documentation du Centre de développement DocuSign pour obtenir des instructions sur la création et la configuration d’applications personnalisées. DocuSign utilise un webhook scripté pour envoyer des données de document signé à l’instance ServiceNow . Cela permet aux concepteurs de flux de mettre en pause un flux jusqu’à ce qu’un document soit signé et d’utiliser les données des documents dans le flux.

    Procédure

    1. Depuis votre compte DocuSign, enregistrez votre application.
    2. Générez une clé d’intégrateur et une clé secrète.
    3. Enregistrez les valeurs de clé d’intégration et de clé secrète pour inscrire l’application en tant que fournisseur OAuth tiers sur votre ServiceNow instance.
      Vous avez besoin de ces valeurs lorsque vous Inscrire DocuSign en tant que fournisseur OAuth
    4. Cliquez sur AJOUTER UNE PAIRE DE CLÉS RSA et enregistrez l’ID de paire de clés, la clé publique et la clé privée.
    5. Ajoutez l’URL de ServiceNow redirection OAuth dans votre compte DocuSign.
      1. Accédez à la Intégrations > Application et clés.
      2. Sous Applications et clés d’intégration, recherchez l’application requise.
      3. Pour l’application requise, cliquez sur la liste déroulante Actions , puis sur Modifier.
      4. Sous Paramètres supplémentaires, cliquez sur Ajouter un URI et ajoutez le point de terminaison de rappel OAuth au format suivant : https://<instance>.service-now.com/oauth_redirect.do.
        Ajouter un URI de redirection dans le compte DocuSign.
    6. Obtenez la valeur de l’URI de base de compte à partir du compte DocuSign.
      1. Accédez à la Intégrations > Application et clés.
      2. Sous Informations sur mon compte, vous pouvez trouver la valeur de l’URI de base du compte.
        URI de base de compte.
      3. Copiez et enregistrez cette valeur pour une utilisation ultérieure.

    Générer le certificat JKS

    Générez un certificat JKS pour l’authentification JWT du Spoke DocuSign eSignaturefichier .

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Ouvrez l’éditeur de texte pour du code tel que Sublime Text.
    2. Créez un nouveau fichier.
    3. Collez la clé privée que vous avez générée précédemment à partir de votre application d’intégration DocuSign.
      Pour plus d'informations, consultez Configurer le compte DocuSign.
      Remarque :
      Assurez-vous d’inclure le début et la fin de la clé privée.
    4. Enregistrez le fichier avec l’extension .key, par exemple privatekey.key.
    5. Ouvrez le terminal et accédez au répertoire où vous avez enregistré le fichier avec l’extension .key .
    6. Créez un certificat signé par une autorité de certification à l’aide de votre clé privée en exécutant la commande : 
      openssl req -new -x509 -key <file-name>.key -out <certificate-name>.pem -days 1095
      Le système vous invite à fournir les détails requis tels que le nom du pays, le nom de la province, et ainsi de suite.
    7. Entrez les détails requis.
    8. Créez un fichier PKCS 12 à l’aide de votre clé privée et d’un certificat signé par l’autorité de certification en exécutant la commande : 
      openssl pkcs12 -export -in <certificate-name>.pem -inkey <file-name>.key -certfile <certificate-name>.pem -out <PKCS-12-file-name>.p12
      Le système vous invite à fournir un mot de passe.
    9. Fournissez le mot de passe d’exportation.
    10. Créez le fichier JKS en exécutant cette commande : 
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
      Le système vous invite à fournir un mot de passe.
    11. Fournissez les mots de passe des magasins de clés de destination et de source.

    Joindre un certificat Java Key Store au Spoke DocuSign eSignature

    Activez l’authentification par jeton JWT Bearer Grant en joignant un certificat Java KeyStore (JKS) valide au Spoke DocuSign eSignaturefichier .

    Avant de commencer

    • Garantir la disponibilité d’un certificat Java KeyStore valide
    • Rôle requis : admin

    Procédure

    1. Accédez à la Tout > Définition du système > Certificats.
    2. Cliquez sur Nouveau.
    3. Renseignez le formulaire.
      Tableau 1. Champs du formulaire Certificat X.509
      Champ Description
      Nom Saisissez un nom pour identifier l’enregistrement de façon unique. Par exemple, Certificat DocuSign.
      Notification à l'expiration Définissez les utilisateurs à notifier lorsque le certificat expire.
      Avertissement avant l'expiration (en jours) Entrez le nombre de jours d’envoi d’une notification avant l’expiration du certificat.
      Actif Activer
      Type Sélectionnez Java Key Store.
      Échéance en jours Entrez le nombre de jours avant l’expiration du certificat.
      Mot de passe de magasin de clés Saisissez un mot de passe associé au certificat.
      Description courte Saisissez un résumé du certificat.
    4. Cliquez sur l’icône Pièces jointes ( icône Pièces jointes) et joignez un certificat JKS.
    5. Cliquez sur Valider les magasins/certificats.

    Créer une clé de signature JWT pour le Spoke DocuSign eSignature

    Créez une clé de signature JSON Web Token (JWT) à affecter à votre certificat Java KeyStore.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tout > OAuth système > Clés JWT.
    2. Cliquez sur Nouveau.
    3. Renseignez le formulaire.
      Tableau 2. Champs du formulaire Clés JWT
      Champ Description
      Nom Saisissez un nom pour identifier de façon unique la clé de signature JWT. Par exemple, les clés DocuSign JWT.
      Magasin de clés de signature Sélectionnez le certificat JKS valide joint à la tâche précédente. Par exemple, Certificat DocuSign.
      ID de clé Entrez un ID de clé pour identifier quelle clé est utilisée lorsque plusieurs clés sont utilisées pour signer les jetons.
      Algorithme de signature Sélectionnez un algorithme pour signer avec la clé JWT.
      Signature avec le mot de passe de clé Entrez un mot de passe associé à la clé de signature.
      Actif Activer.
    4. Cliquez sur Envoyer.

    Créer un fournisseur JWT pour le Spoke DocuSign eSignature

    Ajoutez un fournisseur JSON Web Token (JWT) à votre instance ServiceNow.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tout > OAuth système > Fournisseurs JWT.
    2. Cliquez sur Nouveau.
    3. Renseignez les champs du formulaire.
      Tableau 3. Champs du formulaire Fournisseur JWT
      Champ Description
      Nom Saisissez un nompour identifier de manière unique le fournisseur JWT. Par exemple, Fournisseur DocuSign JWT.
      Intervalle d'expiration (s) Entrez un nombre, en secondes, pour définir l’intervallede temps des jetons du fournisseur JWT.
      Configuration de la signature Sélectionnez une clé de signature JWT. Par exemple, les clés DocuSign JWT.
    4. Cliquez avec le bouton droit de la souris sur l'en-tête du formulaire, puis cliquez sur Enregistrer.
      Les listes connexes Réclamations standard et Réclamations personnalisées s’affichent.
    5. Sélectionnez le fournisseur JWT créé pour le spoke DocuSign.
    6. Entrez les valeurs de iss, sub et aud dans la liste connexe Réclamations standard .
      Consultez le Centre de développement DocuSign pour obtenir des instructions.
    7. Insérez un enregistrement dans la liste connexe Réclamations personnalisées et complétez le formulaire.
      Tableau 4. Champs de la liste connexe Réclamations personnalisées
      Champ Valeur
      Nom de la réclamation périmètre
      Type de valeur de réclamation chaîne
      Valeur de réclamation Emprunt d’identité de signature
    8. Cliquez sur Mettre à jour.

    Inscrire DocuSign en tant que fournisseur OAuth

    Utilisez les informations générées pendant la configuration du compte DocuSign pour enregistrer DocuSign en tant que fournisseur OAuth et permettre à l'instance de demander des jetons OAuth 2.0.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tout > OAuth système > Registre d'application.
    2. Cliquez sur Nouveau.
      Le système affiche le message What kind of OAuth application ?
    3. Sélectionnez Se connecter à un fournisseur OAuth tiers.
      Le système affiche un formulaire de registres d’application vide.
    4. Renseignez le formulaire.
      Champ Valeur requise
      Nom Saisissez un nom pour identifier l’enregistrement de façon unique. Par exemple, entrez DocuSign OAuth.
      ID client Saisissez la clé d’intégrateur que vous avez générée pendant la configuration du compte DocuSign.
      Secret client Saisissez le secret client que vous avez généré pendant la configuration du compte DocuSign.
      Type d'accord par défaut Sélectionnez JWT Bearer.
      URL d'autorisation
      • Pour Developer Sandbox Environment (Environnement sandbox pour développeurs), saisissez https://account-d.docusign.com/oauth/auth.
      • Pour Live Production System (Système de production en direct), saisissez https://account.docusign.com/oauth/auth.
      URL de jeton
      • Pour Developer Sandbox Environment (Environnement sandbox pour développeurs), saisissez https://account-d.docusign.com/oauth/token.
      • Pour Live Production System (Système de production en direct), saisissez https://account.docusign.com/oauth/token. Pour plus d’informations, consultez Référence du point de terminaisonPost Go-Live and User Info (Publier la mise en service et les informations utilisateur) dans la documentation du Centre de développement DocuSign.
    5. Cliquez avec le bouton droit de la souris sur l'en-tête du formulaire, puis cliquez sur Enregistrer.
      • Le système valide les informations d’identification OAuth et renseigne l’URL de redirection.
      • Le système renseigne le profil d’entité OAuth avec le type d’attribution en tant que titulaire JWT. Par exemple, le profil de l’entité OAuth est créé avec le nom par défaut, DocuSign OAuth default_profile
    6. Insérez un enregistrement dans la liste connexe Périmètres des entités OAuth et renseignez les valeurs.
      Tableau 5. Champs de liste connexes Périmètres des entités OAuth
      Champ Valeur
      Nom périmètre
      Périmètre OAuth Emprunt d’identité de signature
    7. Copiez la valeur à partir de l’URL de redirection.
    8. Cliquez sur Mettre à jour.
    9. Connectez-vous à votre compte DocuSign pour modifier la configuration de votre application DocuSign personnalisée.
      Consultez le Centre de développement DocuSign pour obtenir des instructions.
    10. Collez la valeur de l’URL de redirection dans l’URI de redirection de votre application DocuSign personnalisée.
      Par exemple, collez https://instance.service-now.com/oauth_redirect.do

    Résultats

    L’instance peut demander des jetons OAuth 2.0 pour le spoke.
    Remarque :
    Lorsqu’un jeton OAuth expire, le spoke régénère automatiquement un nouveau jeton dans la plupart des cas. Si un jeton expire et n’est pas régénéré, un administrateur peut régénérer le jeton OAuth du spoke.

    Créer des enregistrements d’informations d’identification pour le Spoke DocuSign eSignature

    Créez des enregistrements d'informations d'identification pour l'application OAuth personnalisée de DocuSign que vous avez créée pendant la configuration du compte DocuSign. Les alias de connexion et d'informations d'identification du spoke DocuSign utilisent ces informations d'identification pour autoriser des actions.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tout > Connexions et informations d'identification > Informations d'identification.
    2. Cliquez sur Nouveau.
      Le système affiche le message Quel type d’informations d’identification voulez-vous créer ?.
    3. Sélectionnez Informations d'identification OAuth 2.0.
      La fenêtre contextuelle affiche un formulaire d’informations d’identification OAuth 2.0 vide.
    4. Renseignez ces valeurs.
      Champ Valeur requise
      Nom Saisissez un nom pour identifier l’enregistrement de façon unique. Par exemple, saisissez les informations d’identification DocuSign.
      Actif Activer
      Profil de l'entité OAuth Sélectionnez le profil OAuth que vous avez créé lors de l’inscription de l’application DocuSign personnalisée en tant que fournisseur OAuth. Par exemple, sélectionnez DocuSign OAuth default_profile.
      S'applique à Sélectionnez les MID Servers qui peuvent utiliser ces informations d’identification. Par exemple, sélectionnez Tous les MID Servers.
      Ordre Sélectionnez l’ordre dans lequel appliquer ces informations d’identification. Par exemple, saisissez 100.
    5. Enregistrez l'enregistrement.
    6. Cliquez sur le lien connexe Obtenir le jeton OAuth pour générer le jeton OAuth.

    Créer des enregistrements de connexion pour le Spoke DocuSign eSignature

    Créez des enregistrements de connexion à votre compte DocuSign. Les alias de connexion et d'informations d'identification du spoke DocuSign utilisent ces connexions pour effectuer des actions dans DocuSign.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tout > Connexions et informations d'identification > Alias de connexion et d'informations d'identification.
    2. Ouvert pour l’enregistrement de DocuSign.
    3. Dans l’onglet Connexions , cliquez sur Nouveau.
      Le système affiche un formulaire de connexion HTTP(s) vide.
    4. Entrez ces valeurs.
      Champ Valeur requise
      Nom Saisissez un nom pour identifier de façon unique l’enregistrement de connexion. Par exemple, entrez Connexion DocuSign.
      Informations d'identification Sélectionnez l’enregistrement d’informations d’identification que vous avez créé pour DocuSign. Par exemple, sélectionnez Informations d’identification DocuSign.
      URL de connexion
      • Pour un environnement de démonstration, saisissez https://demo.docusign.net.
      • Pour un système de production opérationnel, entrez l’URI de base tel que na2.docusign.net ou eu.docusign.net. Pour obtenir des instructions sur l’obtention de l’URI de base, consultez Référence du point de terminaisonPost Go-Live and User Info (Référence de point de terminaison Post Go-Live and User Info) dans la documentation du Centre de développement DocuSign.
    5. Cliquez sur Envoyer.

    Que faire ensuite

    Synchronisez ServiceNow avec DocuSign pour accéder aux comptes, modèles et enveloppes DocuSign à partir du spoke DocuSign. Reportez-vous à Synchroniser DocuSign avec ServiceNow.