intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

Copyright © 2014 NTT DATA INTRAMART CORPORATION

↑Top

1

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

目次
改訂情報
OAuth認証モジュール について
基本的な操作
クライアントアプリケーションの登録
クライアントアプリケーションの更新
クライアントアプリケーションの削除
応用的な操作
API キーの管理
ユーザにより発行された API キーを確認する
ユーザにより発行された API キーを削除する
スコープの管理スコープ一覧の確認
スコープの登録
スコープの更新
スコープの削除2

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

改訂情報
変更年月日

変更内容

2014-12-01

初版

2020-04-01

第2版 下記を追加・変更しました「クライアントアプリケーションの登録」に「コード交換用証明キー(PKCE)」の説明を追加しました。
「クライアントアプリケーションの更新」に「コード交換用証明キー(PKCE)」の説明を追加しました。

2023-10-01

第3版 下記を追加・変更しました「OAuth認証モジュール について」に API キーの操作項目を追加しました。
「応用的な操作」に「API キーの管理」を追加しました。

2024-04-01

第4版 下記を追加・変更しました「応用的な操作」に「スコープの管理」を追加しました。
「ユーザにより発行された API キーを確認する」の API キー詳細の画面キャプチャを更新しました。
「基本的な操作」のクライアントアプリケーションの各種操作の画面キャプチャを更新しました。
「OAuth認証モジュール について」に スコープ管理の操作項目を追加しました。

3

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

OAuth認証モジュール について
OAuth認証モジュール は intra-mart Accel Platform 上でOAuth認証機能を利用するためのモジュールです。
OAuth認証を利用することで、アプリケーションがリソースを参照する際にパスワードやその他の認証情報をアプリケーションにさらすことなくアクセスを許可できます。
OAuth認証モジュールの管理者 は以下の操作を行えます。
クライアントアプリケーションを登録する。
クライアントアプリケーションを更新する。
クライアントアプリケーションを削除する。
ユーザにより発行された API キーを確認する。
ユーザにより発行された API キーを削除する。
スコープ一覧を確認する。
スコープを登録する。
スコープを更新する。
スコープを削除する。

コラム
API キーによるアクセス許可機能は intra-mart Accel Platform 2023 Autumn(Hollyhock) 以降のバージョンで利用可能です。

コラム
スコープ管理機能は intra-mart Accel Platform 2024 Spring(Iris) 以降のバージョンで利用可能です。

4

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

基本的な操作
ここでは OAuth認証機能 の基本的な操作を紹介します。

クライアントアプリケーションの登録
クライアントアプリケーションを登録する場合は、以下の手順で行ってください。
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth認証 - アプリケーション管理者 - アプリケーション管理」の順にクリックします。
2. ツールバーの「クライアント追加」をクリックします。

3. フォームの各要素の内容を入力して「登録」をクリックします。

設定項目

説明

クライアントID

クライアントアプリケーションを一意に表すIDを設定します。

標準表示名

クライアントアプリケーションの標準表示名を設定します。 標準表示名はログインユーザのロケールのクライアント名が設定されていない場合に利用されます。

クライアント名（日本語）

日本語ロケールのクライアントアプリケーション名を設定します。

クライアント名（英語）

英語ロケールのクライアントアプリケーション名を設定します。

クライアント名（中国語）

中国語ロケールのクライアントアプリケーション名を設定します。

5

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01
設定項目

説明

認証フロー

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

リダイレクトURI

認証結果をリダイレクトするクライアントアプリケーションのリダイレクトエンドポイントを設定します。

コード交換用証明キー

コード交換用証明キーを要求するかどうかを設定します。 「要求する」を設定した場合、(PKCE)

code_challenge を伴わない認可リクエストを全て拒否します。 「コードチャレンジメソッド S256を要求する」を設定した場合、code_challenge_method=S256 の認可 リクエストのみ受け付けます。code_challenge_method=plainの認可リクエストは拒否します。

説明（日本語）

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

説明（英語）

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

説明（中国語）

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

画像

クライアントアプリケーション画像を設定します。

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

コラム
ラベルの左にある「+」アイコンをクリックすると各ロケールの入力欄が表示されます。
コード交換用証明キー(PKCE)は認証フローに「認可コードフロー」を選択した場合に表示されます。

コラム「コード交換用証明キー(PKCE)」は 2020 Spring(Yorkshire) から追加されました。
1. 「決定」をクリックします。

2. クライアントアプリケーションを登録できました。

クライアントアプリケーションの更新
クライアントアプリケーションを更新する場合は、以下の手順で行ってください。

注意
クライアントアプリケーションの更新を行えるのは、画面から登録したアプリケーションのみです。設定ファイルに定義されているクライアントアプリケーションは更新できません。
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth認証 - アプリケーション管理者 - アプリケーション管理」の順にクリックします。

6

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01
2. クライアントアプリケーション一覧より、利用状況を確認したいアプリケーションをクリックします。

3. フォームの各要素の内容を入力して「更新」をクリックします。

設定項目

説明

クライアントID

クライアントアプリケーションを一意に表すIDを設定します。

標準表示名

クライアントアプリケーションの標準表示名を設定します。 標準表示名はログインユーザのロケールのクライアント名が設定されていない場合に利用されます。

クライアント名（日本語）

日本語ロケールのクライアントアプリケーション名を設定します。

クライアント名（英語）

英語ロケールのクライアントアプリケーション名を設定します。

クライアント名（中国語）

中国語ロケールのクライアントアプリケーション名を設定します。

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

リダイレクトURI

認証結果をリダイレクトするクライアントアプリケーションのリダイレクトエンドポイントを設定します。

コード交換用証明キー

コード交換用証明キーを要求するかどうかを設定します。 「要求する」を設定した場合、(PKCE)

code_challenge を伴わない認可リクエストを全て拒否します。 「コードチャレンジメソッド S256を要求する」を設定した場合、code_challenge_method=S256 の認可 リクエストのみ受け付けます。code_challenge_method=plainの認可リクエストは拒否します。

説明（日本語）

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

説明（英語）

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

7

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01
設定項目

説明

説明（中国語）

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

画像

クライアントアプリケーション画像を設定します。

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

利用ユーザ一覧を開くとアプリケーションを利用しているユーザを確認できます。

コラム
ラベルの左にある「+」アイコンをクリックすると各ロケールの入力欄が表示されます。
コード交換用証明キー(PKCE)は認証フローに「認可コードフロー」を選択した場合に表示されます。

注意
認証フローを変更すると、それまでに利用していたクライアントシークレットやアクセストークンが無効化されます。

コラム「コード交換用証明キー(PKCE)」は 2020 Spring(Yorkshire) から追加されました。
1. 「決定」をクリックします。

2. クライアントアプリケーションを更新できました。

クライアントアプリケーションの削除
クライアントアプリケーションを削除する場合は、以下の手順で行ってください。

注意
クライアントアプリケーションの削除を行えるのは、画面から登録したアプリケーションのみです。設定ファイルに定義されているクライアントアプリケーションを削除することはできません。
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth認証 - アプリケーション管理者 - アプリケーション管理」の順にクリックします。
2. クライアントアプリケーション一覧より、利用状況を確認したいアプリケーションをクリックします。

8

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

3. 「削除」をクリックします。

4. 「決定」をクリックします。

5. クライアントアプリケーションを削除できました。

9intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

応用的な操作
ここでは OAuth認証機能 の応用的な操作を紹介します。

API キーの管理
ユーザにより発行された API キーを管理する方法について紹介します。

ユーザにより発行された API キーを確認する
API キーの一覧を確認する
API キーの詳細を確認する
API キーを検索する

API キーの一覧を確認する
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - API キー管理者 - API キー管理」の順にクリックします。
2. 発行された API キーの一覧が確認できます。

API キーの詳細を確認する
1. 一覧から詳細を確認する API キーの「詳細」列のアイコンをクリックして API キー詳細ダイアログを表示します。

10intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

2. API キー詳細ダイアログから設定情報を確認できます。

項目
基本情報

アクセス範囲

説明
表示名API キーの表示名です。

説明API キーの説明です。

有効日数API キーの有効日数です。

画像

API キーを識別する画像（シンボルマーク等）です。
API キーに許可されているアクセス範囲です。

11intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01
項目

説明

IP アドレス制限

API キーの使用を許可するリモート IP アドレスです。
[m-n] は範囲、* はワイルドカードを意味します。
例えば「 192.168.[0-24].* 」の場合、192.168.0.0 から 192.168.24.255 の範囲のリモート IP アドレスを許可します。

コラム
未設定の場合はすべてのリモート IP アドレスに対して API キーの使用を許可している状態です。

API キーを検索する
1. API キー管理画面中央の検索フィールドに検索条件を入力し、「検索」をクリックします。

項目説明

ID

検索する API キーの ID（の一部）を入力します。

ユーザコード検索する API キーを発行したユーザのユーザコード（の一部）を入力します。

ユーザ名検索する API キーを発行したユーザのユーザ名（の一部）を入力します。

「検索」ボタンAPI キーを検索します。

「クリア」ボタン

入力した検索条件をクリアします。

2. 検索結果が表示されます。

12

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

ユーザにより発行された API キーを削除する
ユーザにより発行された API キーを強制的に削除する場合は、以下の手順で行ってください。
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - API キー管理者 - API キー管理」の順にクリックします。
2. 一覧より、削除する API キーのチェックボックスをオンにします。

3. 「選択済みの API キーを削除」をクリックします。

13

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

4. 「決定」をクリックします。

5. API キーを削除できました。

コラム
API キーの管理機能を利用するには「API キー管理」権限が必要です。

コラム
API キーによるアクセス許可機能は intra-mart Accel Platform 2023 Autumn(Hollyhock) 以降のバージョンで利用可能です。

スコープの管理スコープの管理を行う基本的な操作を紹介します。

スコープ一覧の確認

14

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01
スコープ一覧を確認する
スコープの詳細を確認する
スコープを検索する

スコープ一覧を確認する
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - スコープ管理者 - スコープ一覧」の順にクリックします。
2. スコープの一覧が確認できます。

スコープの詳細を確認する
1. 詳細を確認するスコープのスコープ ID をクリックして、 詳細ダイアログを表示します。

2. スコープ情報詳細ダイアログから設定情報を確認できます。

15

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

項目説明

スコープ情報 スコープスコープ ID です。

表示名スコープの表示名です。

説明

スコープの説明です。

スコープを検索する
1. スコープ一覧画面の検索フィールドに検索条件を入力し、「検索アイコン」をクリックします。

2. 検索結果が表示されます。

16

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

スコープの登録
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - スコープ管理者 - スコープ一覧」の順にクリックします。
2. 「新規作成」をクリックします。

3. 各要素の入力をします。

17

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

項目説明

スコープ情報 スコープ

スコープ ID です。

表示名スコープの表示名です。

説明

スコープの説明です。

4. 「作成」をクリックします。

5. 「決定」をクリックします。

18

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

6. スコープを登録できました。

コラム
以下の画面から表示されるスコープ検索画面からも、スコープを登録できます。
スコープ検索画面からスコープを登録するには、「スコープ管理」権限が必要です。
IM-LogicDesigner のロジックフロールーティング編集画面
ViewCreator のルーティング定義一覧画面
以下の手順でスコープ検索画面より、スコープを登録できます。
1. スコープ検索画面で「新規作成」をクリックします。

2. 各要素の入力をします。
スコープ検索画面から登録できるスコープ情報は、以下のみです。
スコープ
表示名

19

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

項目説明

スコープ情報 スコープ

スコープ ID です。

表示名スコープの表示名です。

3. 「作成」をクリックします。

4. 「決定」をクリックします。

5. スコープを登録できました。

スコープの更新
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - スコープ管理者 - スコープ一覧」の順にクリックします。
2. 更新するスコープのスコープ ID をクリックして、 詳細ダイアログを表示します。

20

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

3. 各要素の入力をします。

項目

説明

スコープ情報 スコープ

スコープ ID です。

表示名スコープの表示名です。

説明

スコープの説明です。

4. 「更新」をクリックします。

21

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

5. 「決定」をクリックします。

6. スコープを更新できました。

コラム
鍵アイコンが表示されているものに関しては更新できません。
参照のみが可能です。
鍵アイコンが表示される対象は以下です。
設定ファイル「クライアントのアクセス範囲設定」にて管理されているスコープ
intra-mart Accel Platform 製品標準にて追加されたスコープ

スコープの削除
1. intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - スコープ管理者 - スコープ一覧」の順にクリックします。
2. 削除するスコープの「削除」をクリックします。

22

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

3. 「決定」をクリックします。

4. スコープを削除できました。

コラム
鍵アイコンが表示されているものに関しては削除できません。
鍵アイコンが表示される対象は以下です。
設定ファイル「クライアントのアクセス範囲設定」にて管理されているスコープ
intra-mart Accel Platform 製品標準にて追加されたスコープ

コラム
スコープの管理機能を利用するには「スコープ管理」権限が必要です。

コラム
スコープ管理機能は intra-mart Accel Platform 2024 Spring(Iris) 以降のバージョンで利用可能です。

23

intra-mart Accel Platform — OAuth 管理者操作ガイド 第4版 2024-04-01

24