intra-mart Accel Platform 設定ファイルリファレンス第34版 2024-04-01

目次 ≪ OAuth認証機能クライアントリソース設定 ≫

クライアント詳細設定¶

項目

概要
リファレンス

概要 ¶

OAuth認証機能を利用するクライアントアプリケーションの詳細を設定します。

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

<?xml version="1.0" encoding="UTF-8"?>
<oauth-client-details-config
    xmlns="http://intra-mart.co.jp/system/oauth/provider/client/config/oauth-client-details-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/system/oauth/provider/client/config/oauth-client-details-config oauth-client-details-config.xsd">
  <client-details>
    <client-detail client-id="sample-iap-client" authorized-grant-type="authorization_code" client-secret="iap-sample">
      <default-name>Accel Platform sample client</default-name>
      <localizations>
        <localize locale="ja">
          <client-name>Accel Platform サンプルクライアント</client-name>
          <description>Accel Platform のサンプルクライアントです。</description>
        </localize>
      </localizations>
      <scopes>
        <scope id="sample" />
      </scopes>
    </client-detail>
  </client-details>
</oauth-client-details-config>

リファレンス ¶

クライアント設定 ¶

タグ名 client-details

OAuth認証を利用するクライアントアプリケーションを設定します。

【設定項目】
<oauth-client-details-config>
  <client-details>
    <client-detail client-id="sample-iap-client">
      ...
    </client-detail>
  </client-details>
</oauth-client-details-config>
必須項目 ○

複数設定 ×

設定値・設定する内容

client-detail クライアントアプリケーションの詳細設定

単位・型なし

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

親タグ oauth-client-details-config

クライアント詳細設定 ¶

タグ名 client-detail

OAuth認証を利用するクライアントアプリケーションの詳細を設定します。

【設定項目】
<client-details>
  <client-detail client-id="sample-iap-client" authorized-grant-type="authorization_code" client-secret="iap-sample">
    ...
  </client-detail>
</client-details>
必須項目 ○

複数設定 ○

設定値・設定する内容 OAuth認証を利用するクライアントアプリケーションの詳細情報を設定します。

単位・型なし

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

親タグ client-details

【属性】

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

client-id クライアントアプリケーションを識別する一意のIDを設定します。 ○ なし

authorized-grant-type
クライアントアプリケーションがアクセストークンを取得する際に用いられる認可種別を設定します。

authorization_code WebアプリケーションでOAuth認証機能を利用する場合に設定します。

implicit ネイティブなモバイルやデスクトップアプリケーションでOAuth認証機能を利用する場合に設定します。

○ なし

client-secret

クライアントのシークレットを設定します。

authorized-grant-type に authorization_code を設定した場合、必須です。

× なし

redirect-uri ユーザ（リソースオーナー）とのやりとりが完了した後にレスポンスをリダイレクトするクライアントのリダイレクトエンドポイントを設定します。 × なし

access-token-validity-seconds アクセストークンの有効期限（秒）を設定します。 × 3600秒（１時間）

icon-path

クライアントアプリケーションのアイコンパスを設定します。

アイコンを設定する場合は、パブリックストレージにアイコン（80x80）を配置し、ルートからのパスを設定してください。

× なし

code-challenge

認可リクエスト時にコード交換用証明キーを要求するかどうかを設定します。

NONE

コード交換用証明キーを要求しない

code_challenge を伴わない認可リクエストを受け付けます。

ALL

コード交換用証明キーを要求する

code_challenge を伴わない認可リクエストを全て拒否します。

PLAIN

コードチャレンジメソッド plain を要求する

code_challenge_method=plain の認可リクエストのみ受け付けます。

S256

コードチャレンジメソッド S256 を要求する。

code_challenge_method=S256 の認可リクエストのみ受け付けます。

× NONE

注意

クライアントのなりすましを防ぐため、 redirect-uri にクライアントアプリケーションのエンドポイントを設定することを推奨します。

コラム

code-challenge は 2020 Spring(Yorkshire) から追加されました。

標準表示名 ¶

タグ名 default-name

クライアントアプリケーションの標準表示名を設定します。

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

【設定項目】
<client-detail client-id="sample-iap-client">
  <default-name>Accel Platform sample client</default-name>
</client-detail>
必須項目 ×

複数設定 ×

設定値・設定する内容クライアントアプリケーションの標準表示名を設定します。

単位・型文字列

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

親タグ client-detail

注意

クライアント詳細設定は複数の設定ファイルで構成されるため、設定ファイル上では標準表示名は必須項目に指定されていませんがシステムの動作上では必須項目です。

各クライアントアプリケーションに対して標準表示名を設定するようにしてください。

クライアント国際化情報 ¶

タグ名 localizations

クライアントアプリケーションの国際化情報を設定します。

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

複数設定 ×

設定値・設定する内容

localize クライアントアプリケーションの各ロケールの情報設定

単位・型なし

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

親タグ client-detail

クライアントアプリケーションの各ロケールの情報 ¶

タグ名 localize

クライアントアプリケーションの各ロケール毎の情報を設定します。

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

複数設定 ○

設定値・設定する内容

client-name クライアントアプリケーションの表示名を設定します。

description クライアントアプリケーションの説明を設定します。

単位・型なし

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

親タグ localizations

【属性】

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

locale ロケールID。 ○ なし

表示名 ¶

タグ名 client-name

クライアントアプリケーションの表示名を設定します。

【設定項目】
<localize locale="ja">
  <client-name>Accel Platform サンプルクライアント</client-name>
</localize>
必須項目 ○

複数設定 ×

設定値・設定する内容クライアントアプリケーションの表示名を設定します。

単位・型文字列

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

親タグ localize

説明 ¶

タグ名 description

クライアントアプリケーションの説明を設定します。

【設定項目】
<localize locale="ja">
  <description>Accel Platform のサンプルクライアントです。</description>
</localize>
必須項目 ○

複数設定 ×

設定値・設定する内容クライアントアプリケーションの説明を設定します。

単位・型文字列

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

親タグ localize

アクセス範囲の設定 ¶

タグ名 scopes

クライアントアプリケーションがユーザ（リソースオーナー）に許可を求めるアクセス範囲を設定します。

【設定項目】
<client-detail client-id="sample-iap-client">
  <scopes>
    <scope id="sample" />
  </scopes>
</client-detail>
必須項目 ×

複数設定 ×

設定値・設定する内容クライアントアプリケーションがユーザ（リソースオーナー）に許可を求めるアクセス範囲を設定します。

単位・型なし

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

親タグ client-detail

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

タグ名 scope

クライアントアプリケーションがユーザ（リソースオーナー）に許可を求めるアクセス範囲の詳細を設定します。

【設定項目】
<scopes>
  <scope id="sample" />
</scopes>
必須項目 ○

複数設定 ○

設定値・設定する内容クライアントアプリケーションがユーザ（リソースオーナー）に許可を求めるアクセス範囲の詳細を設定します。

単位・型なし

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

親タグ scope

【属性】

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

id アクセス範囲を識別する一意のID。 ○ なし

目次 ≪ OAuth認証機能クライアントリソース設定 ≫