IM-Sign 利用ガイド 第5版 2022-06-01

IM-Sign 利用ガイド 第5版 2022-06-01

5.2. 設定ファイル

5.2.1. 概要

クラウドサイン連携 に関する設定です。
モジュール
クラウドサイン連携
フォーマットファイル(xsd)
WEB-INF/schema/cloudsign-config.xsd
設定場所
WEB-INF/conf/cloudsign-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<cloudsign-config
    xmlns="http://intra-mart.co.jp/cloudsign/cloudsign-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/cloudsign/cloudsign-config ../schema/cloudsign-config.xsd">
  <default-client id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"/>
  <clients>
    <client tenant="default" id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" />
    <!--
    <client tenant="sandbox" id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" base-url="https://api-sandbox.cloudsign.jp" />
    -->
  </clients>
</cloudsign-config>

5.2.2. リファレンス

5.2.2.1. デフォルトクライアントID設定

タグ名 default-client
デフォルトとなるクラウドサインのクライアントID

【設定項目】

<cloudsign-config>
  <default-client></default-client>
</cloudsign-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 cloudsign-config タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ cloudsign-config

【属性】

属性名 説明 必須 デフォルト値
id
クラウドサインのクライアントID
なし

5.2.2.2. クライアント設定

タグ名 clients
デフォルトとなるクラウドサインのクライアントID

【設定項目】

<cloudsign-config>
  <clients></clients>
</cloudsign-config>

必須項目
複数設定 ×
設定値・設定する内容 clients タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ cloudsign-config

5.2.2.3. クライアント個別設定

タグ名 client
接続先エージェント一つに関する設定を定義します。

【設定項目】

<cloudsign-config>
  <clients>
    <client tenant="default" id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"></client>
    <client tenant="sandbox" id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" base-url="https://api-sandbox.cloudsign.jp" />
  </clients>
</cloudsign-config>

必須項目
複数設定
設定値・設定する内容 client タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ clients

【属性】

属性名 説明 必須 デフォルト値
tenant
テナント名
なし
id
クラウドサインのクライアントID
なし
base-url
ベースURL
× なし

コラム

クラウドサイン連携における クライアントID の解決は以下の順にて行われます。
  1. ユーザ切り替えタスクによる指定
  2. 外部システムユーザ識別子による指定
  3. 設定ファイルによる指定(当該設定)