DocuSign JWT 権限許可を使用してスポークを設定

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む13読むのに数分

    • インスタンスを統合し、 ServiceNowDocuSign JWT grant を使用して要求を認証 ServiceNow します。

    始める前に

    • 統合ハブサブスクリプションを要求します。
    • DocuSign をアクティブ化します。
    • 必要なロール：admin
    注:
    JWT 権限許可を使用して DocuSign スポークを設定する場合は、認証コード権限許可を使用した設定を無視できます。

    DocuSign アカウントの構成

    DocuSign アカウントからカスタム OAuth アプリケーションを作成し、DocuSign 電子署名スポーク で OAuth 2.0 認証を有効にします。

    始める前に

    DocuSign の要件：
    • DocuSign アカウント
    • ServiceNow とデータ連携するように構成された DocuSign アプリ
    • 必要なロール：DocuSign 管理者

    このタスクについて

    DocuSign アカウントから、次の手順を完了します。カスタムアプリケーションの作成と設定については、DocuSign 開発者センターのドキュメントを参照してください。DocuSign は、スクリプト化された Webhook を使用して、署名済みドキュメントデータを ServiceNow インスタンスに送信します。これにより、ドキュメントが署名されるまで Flow Designer でフローを一時停止し、フローでドキュメントデータを使用できます。

    手順

    1. DocuSign アカウントから、アプリケーションを登録します。
      注:
      [ユーザーアプリケーション (User Application)] の [認証コード許可 (Authorization Code Grant)] オプションを選択していることを確認します。
    2. インテグレーターキーを生成します。
    3. 秘密鍵を生成します。
    4. サードパーティ OAuth プロバイダーとして ServiceNow インスタンスでアプリを登録するインテグレーターキーおよび秘密鍵を記録します。
      この生成されたインテグレーターキーは、次の場合にクライアント ID として入力する必要があります。 OAuth プロバイダーとして DocuSign を登録
    5. [RSA KEYPAIR を追加 (ADD RSA KEYPAIR)] をクリックし、[キーペア ID (Keypair ID)]、[公開鍵 (Public Key)]、および [秘密鍵 (Private Key)] を記録します。
    6. [リダイレクト URI] で、ServiceNow インスタンス URL を https://{instance-name}.service-now.com/api/sn_docusign_spoke/docusign_webhook の形式で追加します。

    JKS 証明書の生成

    DocuSign 電子署名スポークの JWT 認証用に JKS 証明書を生成します。

    始める前に

    必要なロール：admin

    手順

    1. Sublime Text などのコードのテキストエディターを開きます。
    2. 新しいファイルを作成します。
    3. 以前に DocuSign integrator アプリから生成した秘密鍵を貼り付けます。
      詳細については、「DocuSign アカウントの構成」を参照してください。
      注:
      秘密鍵の開始と終了の両方が含まれていることを確認してください。
    4. ファイルを .key 拡張子で保存します (例：privatekey.key)。
    5. ターミナルを開き、.key 拡張子でファイルを保存したディレクトリに移動します。
    6. 次のコマンドを実行し、秘密鍵を使用して CA 署名済み証明書を作成します。 
      openssl req -new -x509 -key <file-name>.key -out <certificate-name>.pem -days 1095
      国名、都道府県名などの必要な詳細を入力するように求められます。
    7. 必要な詳細を入力します。
    8. 次のコマンドを実行し、秘密鍵と CA 署名済み証明書を使用して、PKCS 12 ファイルを作成します。 
      openssl pkcs12 -export -in <certificate-name>.pem -inkey <file-name>.key -certfile <certificate-name>.pem -out <PKCS-12-file-name>.p12
      パスワードの入力を求められます。
    9. エクスポートパスワードを入力します。
    10. 次のコマンドを実行して、JKS ファイルを作成します。 
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
      パスワードの入力を求められます。
    11. 宛先とソースのキーストアのパスワードを入力します。

    Java キーストア証明書を DocuSign 電子署名スポーク に添付する

    有効な Java KeyStore (JKS) 証明書を DocuSign 電子署名スポーク に添付して、JWT ベアラー権限許可トークン認証を有効にします。

    始める前に

    • 有効な Java KeyStore 証明書の可用性の確認
    • 必要なロール：管理者

    手順

    1. 移動先 すべて > システム定義 > 証明書.
    2. [新規] をクリックします。
    3. フォームに入力します。
      表 : 1. X.509 証明書フォームのフィールド
      フィールド 説明
      名前 レコードを一意に識別する名前を入力します。例：「DocuSign 証明書」。
      期限切れ時に通知 証明書の有効期限が切れたときに通知を受信するユーザーを定義します。
      有効期限切れ前に警告 証明書の有効期限が切れる前に通知を送信する日数を入力します。
      有効 有効化
      タイプ [Java Key Store (Java キーストア)] を選択します。
      数日中に期限切れ (Expires in days) 証明書の有効期限が切れるまでの日数を入力します。
      キーストアパスワード 証明書に関連付けられたパスワードを入力します。
      簡単な説明 証明書のサマリーを入力します。
    4. 添付ファイルアイコン (添付ファイルアイコン) をクリックし、JKS 証明書を添付します。
    5. [ストア/証明書を検証] をクリックします。

    DocuSign 電子署名スポークの JWT 署名キーの作成

    Java KeyStore 証明書にアサインする JSON Web トークン (JWT) 署名キーを作成します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > システム OAuth > JWT キー.
    2. [新規] をクリックします。
    3. フォームに入力します。
      表 : 2. JWT キーフォームのフィールド
      フィールド 説明
      名前 JWT 署名キーを一意に識別する名前を入力します。たとえば、「DocuSign JWT キー」。
      署名キーストア 前のタスクで添付された有効な JKS 証明書を選択します。例：「DocuSign 証明書」。
      キー ID 複数のキーを使ってトークンに署名する際に使用するキーを識別するキー ID を入力します。
      署名アルゴリズム JWT キーで署名するアルゴリズムを選択します。
      署名キーパスワード 署名キーに関連付けられたパスワードを入力します。
      有効 有効にします。
    4. [送信] をクリックします。

    DocuSign 電子署名スポークの JWT プロバイダーの作成

    JSON Web トークン (JWT) プロバイダーを ServiceNow インスタンスに追加します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > システム OAuth > JWT プロバイダー.
    2. [新規] をクリックします。
    3. フォームのフィールドに入力します。
      表 : 3. JWT プロバイダーフォームのフィールド
      フィールド 説明
      名前 JWT プロバイダーを一意に識別する名前を入力します。例：「DocuSign JWT プロバイダー」。
      有効期限の間隔 (秒) JWT プロバイダートークンの有効期間を設定する秒数を入力します。
      署名構成 JWT 署名キーを選択します。たとえば、「DocuSign JWT キー」。
    4. フォームヘッダーを右クリックし、[保存] をクリックします。
      [標準要求] および [カスタム要求] 関連リストが表示されます。
    5. DocuSign スポーク用に作成された JWT プロバイダーを選択します。
    6. [標準要求] 関連リストで、[iss]、[sub]、および [aud] の各値を入力します。
      手順については、DocuSign 開発者センターを参照してください。
    7. [カスタム要求] 関連リストにレコードを挿入し、フォームを完成させます。
      表 : 4. カスタム要求関連リストのフィールド
      フィールド 値
      要求名 スコープ
      要求値タイプ 文字列
      要求値 署名の代理操作 (signature impersonation)
    8. [更新] をクリックします。

    OAuth プロバイダーとして DocuSign を登録

    DocuSign アカウントの構成中に生成された情報を使用し、DocuSign を OAuth プロバイダーとして登録して、インスタンスが OAuth 2.0 トークンを要求できるようにします。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > システム OAuth > アプリケーションレジストリー.
    2. [新規] をクリックします。
      「どのような OAuth アプリケーションですか？」というメッセージが表示されます。
    3. [サードパーティ OAuth プロバイダーに接続します] を選択します。
      空のアプリケーション登録フォームが表示されます。
    4. フォームに入力します。
      フィールド 必要な値
      名前 レコードを一意に識別する名前を入力します。たとえば、「DocuSign OAuth」と入力します。
      クライアント ID DocuSign アカウントの構成中に生成したインテグレーターキーを入力します。
      クライアントシークレット DocuSign アカウントの構成中に生成したクライアントシークレットを入力します。
      デフォルトの権限許可タイプ [JWT ベアラー] を選択します。
      認証 URL
      • 開発者サンドボックス環境の場合は、「https://account-d.docusign.com/oauth/auth」と入力します。
      • 本番システムの場合は、「https://account.docusign.com/oauth/auth」と入力します。
      トークン URL
    5. フォームヘッダーを右クリックし、[保存] をクリックします。
      • OAuth 資格情報が検証され、[リダイレクト URL] に情報が入力されます。
      • 権限許可タイプを JWT ベアラーとして [OAuth エンティティプロファイル] に情報が入力されます。たとえば、 [OAuth エンティティプロファイル] は、デフォルトの [名前] の [DocuSign OAuth default_profile] で作成されます。
    6. [OAuth エンティティスコープ] 関連リストにレコードを挿入し、値を入力します。
      表 : 5. OAuth エンティティスコープ関連リストのフィールド
      フィールド 値
      名前 スコープ
      OAuth スコープ 署名の代理操作 (signature impersonation)
    7. [リダイレクト URL] から値をコピーします。
    8. [更新] をクリックします。
    9. DocuSign アカウントにログインし、カスタム DocuSign アプリケーションの構成を編集します。
      手順については、DocuSign 開発者センターを参照してください。
    10. カスタム DocuSign アプリケーションのリダイレクト URL に [リダイレクト URL] の値を貼り付けます。
      たとえば、 貼り付け https://instance.service-now.com/oauth_redirect.do

    タスクの結果

    インスタンスは、スポークの OAuth 2.0 トークンを要求できます。
    注:
    OAuth トークンの有効期限が切れると、ほとんどの場合、スポークは新しいトークンを自動的に再生成します。トークンの有効期限が切れて再生成されない場合、管理者はスポーク OAuth トークンを再生成できます。

    DocuSign 電子署名スポークの資格情報レコードを作成

    DocuSign アカウントの構成時に作成した DocuSign カスタム OAuth アプリケーションに対して資格情報レコードを作成します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 資格情報.
    2. [新規] をクリックします。
      「作成する資格情報のタイプは？」というメッセージが表示されます。
    3. [OAuth 2.0 資格情報] を選択します。
      ポップアップウィンドウに、空の OAuth 2.0 資格情報フォームが表示されます。
    4. 次の値を入力します。
      フィールド 必要な値
      名前 レコードを一意に識別する名前を入力します。たとえば、「DocuSign 資格情報」と入力します。
      有効 有効化
      OAuth エンティティ プロファイル カスタム DocuSign アプリケーションを OAuth プロバイダーとして登録したときに作成した OAuth プロファイルを選択します。たとえば、[DocuSign OAuth default_profile] を選択します。
      適用先 この認証情報を使用できる MID Server を選択します。たとえば、[すべての MID Server] を選択します。
      順番 この認証情報を適用する順番を選択します。たとえば、「100」と入力します。
    5. レコードを保存します。
    6. OAuth トークンを生成するには、[OAuth トークンを取得] 関連リンクをクリックします。

    DocuSign 電子署名スポークの接続レコードを作成

    DocuSign アカウントに接続レコードを作成します。DocuSign スポーク接続および資格情報エイリアスは、これらの接続を使用して、DocuSign でのアクションを許可します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 接続 & 資格情報エイリアス.
    2. DocuSign のレコードを開きます。
    3. [接続] タブで、[新規] をクリックします。
      空の HTTP(s) 接続フォームが表示されます。
    4. 値を入力します。
      フィールド 必要な値
      名前 接続レコードを一意に識別する名前を入力します。たとえば、「DocuSign 接続」と入力します。
      資格情報 DocuSign 用に作成された資格情報レコードを選択します。たとえば、[DocuSign 資格情報] を選択します。
      接続 URL
    5. [送信] をクリックします。

    次のタスク

    ServiceNow を DocuSign と同期して、DocuSign スポークから DocuSign アカウント、テンプレート、エンベロープにアクセスします。「DocuSign と ServiceNow との同期」を参照してください。