IM-BPM for Accel Platform IM-BPM 設定ファイルリファレンス第7版 2023-10-01

目次 ≪ IM-BPM 設定ファイル IM-BPM/Elasticsearch コネクタ ≫

IM-BPM OAuth認証機能クライアントのアクセス範囲設定¶

項目

概要
リファレンス

概要 ¶

OAuth認証機能を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲を設定します。

本設定ファイルを修正することにより、クライアントアプリケーションがユーザ（リソースオーナー）にIM-BPMのリソースの使用許可を要求する際に提示されるスコープの名称や、説明などを変更できます。

モジュール	im_oauth_provider
フォーマットファイル(xsd)	WEB-INF/schema/oauth-client-scopes-config.xsd
設定場所	WEB-INF/conf/oauth-client-scopes-config/oauth-client-scope_im_bpm.xml

<?xml version="1.0" encoding="UTF-8"?>
<oauth-client-scopes-config
  xmlns="http://intra-mart.co.jp/system/oauth/provider/client/scope/config/oauth-client-scopes-config"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://intra-mart.co.jp/system/oauth/provider/client/scope/config/oauth-client-scopes-config oauth-client-scopes-config.xsd ">

  <scopes>
    <scope id="bpm">
      <default-subject>IM-BPM REST API</default-subject>
      <localizations>
        <localize locale="ja">
          <subject>IM-BPM REST API へのアクセス</subject>
          <text>IM-BPM REST API へのアクセスを許可します。</text>
        </localize>
        <localize locale="en">
          <subject>Access to IM-BPM REST API</subject>
          <text>Allow the access to IM-BPM REST API.</text>
        </localize>
        <localize locale="zh_CN">
          <subject>访问IM-BPM REST API</subject>
          <text>允许访问IM-BPM REST API。</text>
        </localize>
      </localizations>
    </scope>
  </scopes>

</oauth-client-scopes-config>

リファレンス ¶

アクセス範囲設定 ¶

タグ名 scopes

OAuth認証を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲を設定します。

【設定項目】
<oauth-client-scopes-config>
  <scopes>
    <scope id="bpm">
      ...
    </scope>
  </scopes>
</oauth-client-scopes-config>
必須項目 ○

複数設定 ×

設定値・設定する内容

scope ユーザに要求するアクセス範囲の設定

単位・型なし

省略時のデフォルト値なし

親タグ oauth-client-scopes-config

アクセス範囲の詳細設定 ¶

タグ名 scope

OAuth認証を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲の詳細情報を設定します。

なお、本設定ファイルの対象アクセス範囲は「bpm」固定です。修正は行わないでください。

【設定項目】
<scopes>
  <scope id="bpm">
    <default-subject>IM-BPM REST API</default-subject>
  </scope>
</scopes>
必須項目 ○

複数設定 ○

設定値・設定する内容ユーザの要求するアクセス範囲の詳細情報を設定します。

単位・型なし

省略時のデフォルト値なし

親タグ scopes

【属性】

属性名説明必須デフォルト値

id 「bpm」固定 ○ なし

標準表示名 ¶

タグ名 default-subject

アクセス範囲を表す標準表示名を設定します。

標準表示名はログインユーザのロケールに一致する表示名が設定されていない場合に利用されます。

【設定項目】
<scope id="bpm">
  <default-subject>IM-BPM REST API</default-subject>
</scope>
必須項目 ×

複数設定 ×

設定値・設定する内容アクセス範囲を表す標準表示名を設定します。

単位・型文字列

省略時のデフォルト値なし

親タグ scope

注意

設定ファイル上では標準表示名は必須項目に指定されていませんがシステムの動作上では必須項目です。

アクセス範囲を表す国際化情報 ¶

タグ名 localizations

アクセス範囲を表す国際化情報を設定します。

【設定項目】
<scope id="sample">
  <localizations>
    <localize locale="ja">
      ...
    </localize>
  </localizations>
</scope>
必須項目 ×

複数設定 ×

設定値・設定する内容

localize アクセス範囲を表す各ロケールの情報設定

単位・型なし

省略時のデフォルト値なし

親タグ scope

アクセス範囲を表す各ロケールの情報 ¶

タグ名 localize

アクセス範囲を表す各ロケール情報を設定します。

【設定項目】
<localizations>
  <localize locale="ja">
    ...
  </localize>
</localizations>
必須項目 ○

複数設定 ○

設定値・設定する内容

subject アクセス範囲を表す表示名を設定します。

text 操作対象となるリソース等、アクセス範囲の説明を設定します。

単位・型なし

省略時のデフォルト値なし

親タグ localizations

【属性】

属性名説明必須デフォルト値

locale ロケールID。 ○ なし

アクセス範囲を表す表示名 ¶

タグ名 subject

アクセス範囲を表す表示名を設定します。

【設定項目】
<localize locale="ja">
  <subject>IM-BPM REST API へのアクセス</subject>
</localize>
必須項目 ○

複数設定 ×

設定値・設定する内容アクセス範囲を表す表示名を設定します。

単位・型文字列

省略時のデフォルト値なし

親タグ localize

アクセス範囲の説明 ¶

タグ名 text

操作対象となるリソース等、アクセス範囲の説明を設定します。

【設定項目】
<localize locale="ja">
  <text>IM-BPM REST API へのアクセスを許可します。</text>
</localize>
必須項目 ○

複数設定 ×

設定値・設定する内容操作対象となるリソース等、アクセス範囲の説明を設定します。

単位・型文字列

省略時のデフォルト値なし

親タグ localize

目次 ≪ IM-BPM 設定ファイル IM-BPM/Elasticsearch コネクタ ≫