OAuthプロバイダ設定¶

項目

概要
リファレンス

概要 ¶

外部連携アプリケーションで利用するOAuthプロバイダの情報を設定します。

OAuthプロバイダとはOAuth2.0のサービスを提供するプロバイダを指します。

コラム

OAuth2.0の仕様や用語については、以下を参照してください。リンク先は 2015年12月1日時点で情報を確認しています。

「The OAuth 2.0 Authorization Framework」

https://tools.ietf.org/html/rfc6749 （English）
http://openid-foundation-japan.github.io/rfc6749.ja.html （日本語）

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

 <?xml version="1.0" encoding="UTF-8"?>
 <oauth-provider-config xmlns="http://www.intra-mart.jp/system/oauth/client/config/oauth-provider-config"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.intra-mart.jp/system/oauth/client/config/oauth-provider-config ../schema/oauth-provider-config.xsd ">
   <oauth-providers>
     <oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
       <provider-type>Sample Provider</provider-type>
       <name message-cd="SAMPLE.NAME">Sample Provider API</name>
       <description message-cd="SAMPLE.DESCRIPTION">It is allow the use of Sample Provider API. </description>
       <icon-path>foo/sample_icon.png</icon-path>
       <oauth-config>
         <authz-end-point>https://sample-authz-end-point.com</authz-end-point>
         <token-end-point>https://sample-token-end-point.com</token-end-point>
         <client-id>Client ID</client-id>
         <client-secret cryption="category">Client Secret</client-secret>
         <scope>Sample Scope</scope>
         <code-challenge-method>S256</code-challenge-method>
       </oauth-config>
       <extra-config>
         <parameter name="sample">sample_parameter</parameter>
       </extra-config>
     </oauth-provider>
   </oauth-providers>
</oauth-provider-config>

リファレンス ¶

OAuthプロバイダ設定 ¶

タグ名 oauth-providers

OAuthプロバイダを設定します。

【設定項目】
<oauth-provider-config>
  <oauth-providers>
      ...
  </oauth-providers>
</oauth-provider-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

oauth-provider プロバイダ詳細設定

単位・型なし

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

親タグ oauth-provider-config

プロバイダ詳細設定 ¶

タグ名 oauth-provider

OAuthプロバイダの詳細を設定します。

【設定項目】
<oauth-providers>
  <oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
    <provider-type>Sample Provider</provider-type>
    <name message-cd="SAMPLE.NAME">Sample Provider API</name>
    <description message-cd="SAMPLE.DESCRIPTION">It is allow the use of Sample Provider API. </description>
    <icon-path>foo/sample_icon.png</icon-path>
    <oauth-config>
        ...
    </oauth-config>
    <extra-config>
        ...
    </extra-config>
  </oauth-provider>
</oauth-providers>
必須項目 ×

複数設定 ○

設定値・設定する内容

provider-type プロバイダ種別

name 表示名

description 説明

icon-path アイコンパス

oauth-config OAuth設定

extra-config 追加設定

単位・型なし

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

親タグ oauth-providers

【属性】

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

id プロバイダを識別する一意のIDを設定します。 ○ なし

target-tenant

利用できる intra-mart Accel Platform のテナントID を設定します。

複数のテナントを指定する場合、テナントID は半角スペースで区切って記載してください。

テナントID の指定がない場合、全てのテナントで利用が可能です。

× なし

プロバイダ種別 ¶

タグ名 provider-type

利用するモジュールに適したOAuthプロバイダの種別を設定します。

【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
      <provider-type>Sample Provider</provider-type>
</oauth-provider>
必須項目 ○

複数設定 ×

設定値・設定する内容利用するモジュールに適したプロバイダ種別を設定します。

単位・型先頭と末尾の空白、2つ以上の連続する空白、キャリッジリターン、ラインフィード、タブを含まない文字列

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

親タグ oauth-provider

コラム

Office 365 連携モジュールを利用する場合、プロバイダ種別は「office365」を指定してください。

表示名 ¶

タグ名 name

OAuthプロバイダの表示名を設定します。

【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
  <name message-cd="SAMPLE.NAME">Sample Provider API</name>
</oauth-provider>
必須項目 ○

複数設定 ×

設定値・設定する内容プロバイダの表示名を設定します。メッセージコードを指定することで多言語に対応できます。

単位・型なし

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

親タグ oauth-provider

【属性】

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

message-cd メッセージコードを設定します。このコードをもとにメッセージリソースを取得し、表示名を表示します。 × なし

説明 ¶

タグ名 description

OAuthプロバイダの説明を設定します。

【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
  <description message-cd="SAMPLE.DESCRIPTION">It is allow the use of Sample Provider API. </description>
</oauth-provider>
必須項目 ×

複数設定 ×

設定値・設定する内容 OAuthプロバイダの説明を設定します。メッセージコードを指定することで多言語に対応できます。

単位・型なし

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

親タグ oauth-provider

【属性】

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

message-cd メッセージコードを設定します。このコードをもとにメッセージリソースを取得し、説明を表示します。 × なし

アイコンパス ¶

タグ名 icon-path

OAuthプロバイダのアイコンパスを設定します。

【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
  <icon-path>foo/sample_icon.png</icon-path>
</oauth-provider>
必須項目 ×

複数設定 ×

設定値・設定する内容

OAuthプロバイダのアイコンパスを設定します。

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

単位・型文字列

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

親タグ oauth-provider

OAuth設定 ¶

タグ名 oauth-config

アクセストークンの取得に必要な情報を設定します。
【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
  <oauth-config>
    <authz-end-point>https://sample-authz-end-point.com</authz-end-point>
    <token-end-point>https://sample-token-end-point.com</token-end-point>
    <client-id>Client ID</client-id>
    <client-secret cryption="category">Client Secret</client-secret>
    <scope>Sample Scope</scope>
    <code-challenge-method>S256</code-challenge-method>
  </oauth-config>
</oauth-provider>
必須項目 ○

複数設定 ×

設定値・設定する内容

authz-end-point OAuth認可エンドポイント

token-end-point トークンエンドポイント

client-id クライアントID

client-secret クライアントシークレット

scope アクセス範囲

code-challenge-method コード交換用証明キー

単位・型なし

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

親タグ oauth-provider

認可エンドポイント ¶

タグ名 authz-end-point

認可コードを取得するための認可エンドポイントを設定します。

【設定項目】
<oauth-config>
  <authz-end-point>https://sample-authz-end-point.com</authz-end-point>
</oauth-config>
必須項目 ○

複数設定 ×

設定値・設定する内容認可コードを取得するための認可エンドポイントのURIを設定します。

単位・型 URI

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

親タグ oauth-config

トークンエンドポイント ¶

タグ名 token-end-point

アクセストークンを取得するためのトークンエンドポイントを設定します。

【設定項目】
<oauth-config>
  <token-end-point>https://sample-token-end-point.com</token-end-point>
</oauth-config>
必須項目 ○

複数設定 ×

設定値・設定する内容アクセストークンを取得するためのトークンエンドポイントのURIを設定します。

単位・型なし

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

親タグ oauth-config

クライアントID ¶

タグ名 client-id

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

【設定項目】
<oauth-config>
  <client-id>Client ID</client-id>
</oauth-config>
必須項目 ○

複数設定 ×

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

単位・型先頭と末尾の空白、2つ以上の連続する空白、キャリッジリターン、ラインフィード、タブを含まない文字列

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

親タグ oauth-config

コラム

Office 365 連携の設定ファイルとして利用する場合、クライアントIDには Microsoft Azure 管理者が取得したアプリケーションのクライアントIDを指定してください。

詳細は「Office 365 連携セットアップガイド」-「アプリケーションの構成を変更する」を参照してください。

クライアントシークレット ¶

タグ名 client-secret

利用するアプリケーションのクライアントシークレットを設定します。

cryption 属性が設定されている場合、指定の方式で暗号化された文字列を設定します。

cryption 属性に設定するカテゴリは、「暗号化設定」を参照してください。

【設定項目】
<oauth-config>
  <client-secret cryption="category">Client Secret</client-secret>
</oauth-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

利用するアプリケーションのクライアントシークレットを設定します。

cryption 属性が設定されている場合、指定の方式で暗号化された文字列を設定します。

cryption 属性が設定されていない場合、パスワードをそのまま設定します。

単位・型なし

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

親タグ oauth-config

【属性】

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

cryption 暗号化したパスワードを設定する場合に、暗号化方式のカテゴリを指定します。 × なし

注意

パスワード文字列を暗号化するためのツールは提供されません。
Java API CryptionUtil を利用して、指定したカテゴリで暗号化するプログラムを作成する必要があります。
Java API CryptionUtil の詳細は「CryptionUtil APIドキュメント」を参照してください。

コラム

Office 365 連携の設定ファイルとして利用する場合、クライアントシークレットには Microsoft Azure 管理者が取得したアプリケーションのキーを指定してください。

詳細は「Office 365 連携セットアップガイド」-「アプリケーションの構成を変更する」を参照してください。

アクセス範囲（スコープ）¶

タグ名 scope

認可サーバに要求するアクセス範囲を設定します。

詳細は利用するOAuthプロバイダのマニュアルを参照してください。

【設定項目】
<oauth-config>
  <scope>Sample Scope</scope>
</oauth-config>
必須項目 ×

複数設定 ×

設定値・設定する内容認可サーバに要求するアクセス範囲を設定します。

単位・型先頭と末尾の空白、2つ以上の連続する空白、キャリッジリターン、ラインフィード、タブを含まない文字列

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

親タグ oauth-config

コード交換用証明キー(PKCE)¶

タグ名 code-challenge-method

認可コードリクエスト時に送信するコード交換用証明キーの計算ロジックを設定します。

計算ロジックに NONE が設定されている場合はコード交換用証明キーは送信されません。

詳細は「Proof Key for Code Exchange by OAuth Public Clients (RFC 7636) 」を参照してください。

【設定項目】
<oauth-config>
  <code-challenge-method>S256</code-challenge-method>
</oauth-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

認可コードリクエスト時に送信するコード交換用証明キー(code_challenge)の計算ロジック(code_challenge_method)を設定します。

NONE コード交換用証明キーを送信しません。

PLAIN 変換は行わず、code_verifierの値をそのまま送信します。

S256 SHA-256 のハッシュ値へ変換して送信します。

単位・型文字列

省略時のデフォルト値 NONE

親タグ oauth-config

追加設定 ¶

タグ名 extra-config

任意の追加情報を設定します。

【設定項目】
<oauth-provider id="sample_provider_id" target-tenant="sample_tenant">
  <extra-config>
    <parameter name="sample">sample_parameter</parameter>
  </extra-config>
</oauth-provider>
必須項目 ×

複数設定 ×

設定値・設定する内容

parameter 追加情報のパラメータ

単位・型なし

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

親タグ oauth-provider

パラメータ ¶

タグ名 parameter

追加情報のパラメータを設定します。

【設定項目】
<extra-config>
  <parameter name="sample">sample_parameter</parameter>
</extra-config>
必須項目 ×

複数設定 ○

設定値・設定する内容追加情報のパラメータを設定します。

単位・型なし

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

親タグ extra-config

【属性】

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

name パラメータ名。 ○ なし

コラム

Office 365 連携の設定ファイルとして利用する場合、以下のパラメータを追加する必要があります。

詳細は「Office 365 連携セットアップガイド」-「追加設定（SharePoint）」を参照してください。

<parameter name=”resource”> にhttps://< Office 365 のテナント>.sharepoint.com となるように指定します。
<parameter name=”sharepoint.tenant”> に Office 365 のFiles API の操作対象となる Office 365 のテナントを指定します。

目次