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

クライアントリソース設定

概要

OAuth認証機能を利用してアクセスするリソースの設定を行います。

モジュール im_oauth_provider
フォーマットファイル(xsd) WEB-INF/schema/oauth-client-resources-config.xsd
設定場所 WEB-INF/conf/oauth-client-resources-config/{任意のファイル名}.xml

<?xml version="1.0" encoding="UTF-8"?>
<oauth-client-resources-config
    xmlns="http://intra-mart.co.jp/system/oauth/provider/client/resource/config/oauth-client-resources-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/system/oauth/provider/client/resource/config/oauth-client-resources-config oauth-client-resources-config.xsd">
  <client-resources>
    <client-resource id="sample-jssp-resource" path="/oauth/jssp/sample" type="jssp" target="sample/oauth/resource">
      <authz uri="service://oauth/sample" action="execute"/>
      <scope id="sample"/>
    </client-resource>
    <client-resource id="sample-java-resource" path="/oauth/java/sample" type="java" target="jp.co.intra_mart.oauth.sample.Resource">
      <authz uri="service://oauth/sample" action="execute"/>
      <scope id="sample"/>
    </client-resource>
  </client-resources>
</oauth-client-resources-config>

リファレンス

デフォルト認可設定

タグ名 authz-default

同じ設定ファイル上でのデフォルトの認可設定を行います。

【設定項目】

<oauth-client-resources-config>
  <authz-default uri="service://application/default" action="execute" />
</oauth-client-resources-config>

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

【属性】

属性名 説明 必須 デフォルト値
uri 認可リソースURIを指定します。 × なし
action 認可アクションを指定します。 × なし
mapper
認可リソースマッパーを指定します。
使用可能な値はauthz-resource-mapper設定で設定済みの値です。
× なし

注意

この設定は、以下のいずれかの設定を行う必要があります。
uri属性とaction属性
mapper属性

リソース設定

タグ名 client-resources
OAuth認証機能を利用してアクセスするリソースの設定を行います。

【設定項目】

<client-resources>
  <client-resource id="sample-jssp-resource">
    ...
  </client-resource>
</client-resources>

必須項目
複数設定
設定値・設定する内容
client-resource OAuth認証機能を利用してアクセスするリソースのURL等、詳細情報を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ oauth-client-resources-config

リソース詳細設定

タグ名 client-resource
OAuth認証機能を利用してアクセスするリソースのURL等、詳細情報を設定します。

【設定項目】

<oauth-client-resources-config>
  <client-resources>
    <client-resource id="sample-jssp-resource" path="/oauth/jssp/sample" type="jssp" target="sample/oauth/resource">
      ...
    </client-resource>
  </client-resources>
</oauth-client-resources-config>

必須項目
複数設定 ×
設定値・設定する内容
authz リソースにアクセスするために必要な認可を設定します。
scope リソースにアクセスするために必要なアクセス範囲を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ client-resources

【属性】

属性名 説明 必須 デフォルト値
id リソースを識別する一意のIDを設定します。 なし
path リソースのURLを設定します。 なし
type
jssp スクリプト開発モデルで作成したリソースの場合に指定します。
java Javaで作成したリソースの場合に指定します。
なし
target
type が jssp の場合は、スクリプト開発モデルのプログラムのパスを設定します。
type が java の場合は、実装クラス名を設定します。
なし

認可設定

タグ名 authz

認可設定

【設定項目】

<client-resource id="sample-jssp-resource">
  <authz mapper="sample-mapper">
    ...
  </authz>
</client-resource>

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

【属性】

属性名 説明 必須 デフォルト値
uri 認可リソースURIを指定します。 × なし
action 認可アクションを指定します。 × なし
mapper
認可リソースマッパーを指定します。
使用可能な値はルーティング用 認可リソースマッパー設定で設定済みの値です。
× なし

コラム

authz-defaultタグが指定されていて、かつ、client-resourceタグにauthzタグが指定されていた場合、authzタグの認可設定が優先されます。

注意

この設定は、以下のいずれかの設定を行う必要があります。
uri属性とaction属性
mapper属性

アクセス範囲設定

タグ名 scope
このリソースを使用するため許可が必要となるアクセス範囲を設定します。

【設定項目】

<client-resource id="sample-jssp-resource">
  <scope id="sample"/>
</client-resource>

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

【属性】

属性名 説明 必須 デフォルト値
id アクセス範囲を識別する一意のID。 × なし