intra-mart Accel Platform 設定ファイルリファレンス 第33版 2023-10-01

クライアントのアクセス範囲設定

概要

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

モジュール im_oauth_provider
フォーマットファイル(xsd) WEB-INF/schema/oauth-client-scopes-config.xsd
設定場所 WEB-INF/conf/oauth-client-scopes-config/{任意のファイル名}.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="sample">
      <default-subject>sample scope</default-subject>
      <localizations>
        <localize locale="ja">
          <subject>サンプルスコープ</subject>
          <text>サンプルデータへのアクセスを許可します。</text>
        </localize>
      </localizations>
    </scope>
  </scopes>
</oauth-client-scopes-config>

リファレンス

アクセス範囲設定

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

【設定項目】

<oauth-client-scopes-config>
  <scopes>
    <scope id="sample">
      ...
    </scope>
  </scopes>
</oauth-client-scopes-config>

必須項目
複数設定 ×
設定値・設定する内容
scope ユーザに要求するアクセス範囲の設定
単位・型 なし
省略時のデフォルト値 なし
親タグ oauth-client-scopes-config

アクセス範囲の詳細設定

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

【設定項目】

<scopes>
  <scope id="sample">
    <default-subject>sample scope</default-subject>
  </scope>
</scopes>

必須項目
複数設定
設定値・設定する内容 ユーザの要求するアクセス範囲の詳細情報を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ scopes

【属性】

属性名 説明 必須 デフォルト値
id スコープを識別する一意のIDを設定します。 なし

標準表示名

タグ名 default-subject
アクセス範囲表す標準表示名を設定します。
標準表示名はログインユーザのロケールに一致する表示名が設定されていない場合に利用されます。

【設定項目】

<scope id="sample">
  <default-subject>sample scope</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>sample scope</subject>
</localize>

必須項目
複数設定 ×
設定値・設定する内容 アクセス範囲を表す表示名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ localize

アクセス範囲の説明

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

【設定項目】

<localize locale="ja">
  <text>サンプルデータへのアクセスを許可します。</text>
</localize>

必須項目
複数設定 ×
設定値・設定する内容 操作対象となるリソース等、アクセス範囲の説明を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ localize