diff --git a/docs/manuals/ADMIN/base/README.md b/docs/manuals/ADMIN/base/README.md index fdd1fde5..9f462ee6 100644 --- a/docs/manuals/ADMIN/base/README.md +++ b/docs/manuals/ADMIN/base/README.md @@ -3776,34 +3776,34 @@ CNRIハンドル設定ユーザ 閲覧権限

インデックスの閲覧権限を設定します。

-

［ロール権限あり］および［グループ権限あり］に表示されているロールおよびグループに所属しているユーザが、そのインデックスを閲覧できます。

+

［ロール権限あり］に表示されているロールの中から1つ以上のロールを持ち、さらに［グループ権限あり］に表示されているグループから1つ以上のグループに所属しているユーザが、そのインデックスを閲覧できます。

+

"Authenticated User"はログインユーザ、"Guest"は未ログインユーザを指すロールであり、"No Group"は未ログインユーザとグループに所属しないログインユーザを指すグループです。

-

ユーザロールごとの閲覧権限を設定します。［子インデックスのベース権限にも再帰的に反映させる］にチェックがある場合、所属するすべての子インデックスと子孫インデックスにロール権限の設定が再帰的に設定されます。

+

ユーザロールごとの閲覧権限を設定します。［子インデックスのロール権限にも再帰的に反映させる］にチェックがある場合、所属するすべての子インデックスと子孫インデックスにロール権限の設定が再帰的に設定されます。

-

ユーザが所属しているグループごとの閲覧権限を設定します。［子インデックスのグループにも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定されます。

-

学認経由でのログイン時にGakuNin mAPからの情報に従って付与されたグループの閲覧権限に設定ファイルを用いてデフォルトの権限を付与できます。

-

※学認経由でのログイン時に付与されたGakuNin mAPグループは内部的にロールとして扱われます。

+

ユーザが所属しているグループごとの閲覧権限を設定します。［子インデックスのグループ権限にも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定されます。

+

学認経由でのログイン時にGakuNin mAPからの情報に従って付与されたグループの閲覧権限に設定ファイルを用いてデフォルトの権限を付与できます。

投稿権限

インデックスにアイテムを投稿する権限を設定します。

-

［ロール権限あり］および［グループ権限あり］に表示されているロールおよびグループに所属しているユーザが、そのインデックスにアイテムを登録できます。

+

［ロール権限あり］に表示されているロールの中から1つ以上のロールを持ち、さらに［グループ権限あり］に表示されているグループから1つ以上のグループに所属しているユーザが、そのインデックスにアイテムを登録できます。

+

"Authenticated User"はログインユーザ、"Guest"は未ログインユーザを指すロールであり、"No Group"は未ログインユーザとグループに所属しないログインユーザを指すグループです。

-

ユーザ情報のベース権限ごとの投稿権限を設定します。

-

［子インデックスのベース権限にも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにロール権限の設定が再帰的に設定されます。

+

ユーザロールごとの投稿権限を設定します。

+

［子インデックスのロール権限にも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにロール権限の設定が再帰的に設定されます。

ユーザが所属しているグループごとの投稿権限を設定します。

-

［子インデックスのグループにも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定されます。

-

学認経由でのログイン時にGakuNin mAPからの情報に従って付与されたグループの投稿権限に設定ファイルを用いてデフォルトの権限を付与できます。

-

※学認経由でのログイン時に付与されたGakuNin mAPグループは内部的にロールとして扱われます。

+

［子インデックスのグループ権限にも再帰的に反映させる］にチェックがある場合、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定されます。

+

学認経由でのログイン時にGakuNin mAPからの情報に従って付与されたグループの投稿権限に設定ファイルを用いてデフォルトの権限を付与できます。

表示形式(検索結果) @@ -9933,7 +9933,7 @@ Session activityを参照する方法を説明します。 | Email | メールアドレスを入力します。必ず入力してください。 | | Password | パスワードを入力します。 | | Active | 作成したユーザのログインを許可する場合、Activeをチェックします。 | -| Roles | ユーザのロールを選択します。 | +| Roles | ユーザのロールを選択します。| | Groups | ユーザのグループを選択します。 | | Send User Notification | ユーザの追加についてメール送信する場合、チェックします。 | diff --git "a/docs/manuals/\346\234\252\347\227\205USER/base/README.md" "b/docs/manuals/\346\234\252\347\227\205USER/base/README.md" index b6329168..c1bbafb4 100644 --- "a/docs/manuals/\346\234\252\347\227\205USER/base/README.md" +++ "b/docs/manuals/\346\234\252\347\227\205USER/base/README.md" @@ -1,12 +1,10 @@ -# 未病データベース画面ユーザ操作マニュアル - -一般閲覧者 +# 未病データベース ユーザ操作マニュアル ## はじめに -このマニュアルは、未病用の WEKO3 システム（以下、システムと称す）で登録したアイテムを閲覧する未病データベース画面（以下、未病データベースと称す）の操作方法を説明したものです。 +このマニュアルは、未病データベースの操作方法を説明したものです。 -- 対象読者 +### 対象読者 本書は次の方を対象としています。 @@ -58,7 +56,7 @@ ## 目次 -[第１章 未病データベースの概要](#第１章未病データベースの概要)
+[第１章 未病データベースの概要](#第１章-未病データベースの概要)
　 ┣[1.1 未病データベースとは](#未病データベースとは)
　 ┗[1.2 各画面説明](#各画面説明)
　　 ┣[1.2.1 最新情報画面](#最新情報画面)
@@ -68,29 +66,29 @@ 　　 ┣[1.2.5 アイテム詳細画面](#アイテム詳細画面)
　　 ┗[1.2.6 ファイル一覧画面](#ファイル一覧画面)
-[第２章 ログインまたはログアウトする](#第２章ログインまたはログアウトする)
+[第２章 ログインまたはログアウトする](#第２章-ログインまたはログアウトする)
　 ┣[2.1 最新情報画面を表示する](#最新情報画面を表示する)
　 ┣[2.2 ログインする](#ログインする)
　 ┗[2.3 ログアウトする](#ログアウトする) -[第３章 アイテムを検索する](#第３章アイテムを検索する)
+[第３章 アイテムを検索する](#第３章-アイテムを検索する)
　 ┣[3.1 検索フォーム 各部名称説明](#検索フォーム各部名称説明)
　 ┣[3.2 詳細検索](#詳細検索)
　 ┣[3.3 フィルター検索](#フィルター検索)
　 ┗[3.4 検索条件をコピーする](#検索条件をコピーする) -[第４章 アイテムをダウンロードする](#第４章アイテムをダウンロードする)
+[第４章 アイテムをダウンロードする](#第４章-アイテムをダウンロードする)
　 ┣[4.1 サマリーテーブル 各部名称説明](#サマリーテーブル各部名称説明)
　 ┗[4.2 検索したアイテムをダウンロードする](#検索したアイテムをダウンロードする) -[第５章 アイテムの詳細を表示する](#第５章アイテムの詳細を表示する)
+[第５章 アイテムの詳細を表示する](#第５章-アイテムの詳細を表示する)
　 ┣[5.1 アイテム詳細画面 各部名称説明](#アイテム詳細画面各部名称説明)
　 ┣[5.2 タブの切り替え](#タブの切り替え)
　 ┣[5.3 セクションの切り替え](#セクションの切り替え)
　 ┣[5.4 リクエストメール](#リクエストメール)
-　 ┗[5.5 GakuNin RDM](#GakuNinRDM) +　 ┗[5.5 GakuNin RDM](#gakunin-rdm) -[第６章 添付ファイルを確認する](#第６章添付ファイルを確認する)
+[第６章 添付ファイルを確認する](#第６章-添付ファイルを確認する)
　 ┣[6.1 ファイル一覧画面 各部名称説明](#ファイル一覧画面各部名称説明)
　 ┣[6.2 ファイルをプレビューで確認する](#ファイルをプレビューで確認する)
　 ┣[6.3 フィルターで絞り込みする](#フィルターで絞り込みする)
@@ -100,17 +98,17 @@ 　　 ┗[6.4.3 個別ダウンロード](#個別ダウンロード)
　 ┗[6.5 ライセンスを確認する](#ライセンスを確認する) -## 第１章　未病データベースの概要 +## 第１章 未病データベースの概要 この章では未病データベースについて説明します。 ### 未病データベースとは -未病データベースとは様々な学実機関により登録された論文や研究データのメタデータ、それらの実ファイルによって構成される情報群（以下、アイテム）の検索、閲覧、ファイルの参照やダウンロードができる WEB サービスです。 +未病データベースとは様々な学術機関により登録された論文や研究データのメタデータ、それらの実ファイルによって構成される情報群（以下、アイテム）の検索、閲覧、ファイルの参照やダウンロードができる WEB サービスです。 ### 各画面説明 -未病データベースは大きく分類して以下の 5 つの画面で構成されています。 +未病データベースは大きく分類して以下の 6 つの画面で構成されています。 #### 最新情報画面 @@ -124,7 +122,7 @@ 未病データベースへログインするための画面です。 - 図 1-2 ログイン画面
- + #### ログアウト画面 @@ -154,7 +152,7 @@ - 図 1-6 ファイル一覧画面
-## 第２章　ログインまたはログアウトする +## 第２章 ログインまたはログアウトする この章では、未病データベースに[ログイン]または[ログアウト]する方法を説明します。 @@ -163,67 +161,63 @@ - 図 2-1 最新情報画面
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 2‑1 最新情報画面 項目と説明
項番項目説明
1[]アイコン -

クリックすると最新情報画面に遷移します。

2[]プルダウンリスト言語の切り替えが出来ます。
-切替はja（日本語）とen（英語）の二種類です。
3[]ボタン／
[]ボタン -		クリックすると[ログイン]もしくは[ログアウト]画面へ遷移します。
4[]ボタンクリックするとインデックス一覧を表示します。
5[検索フォーム]アイテムを検索することが出来ます。
-[]ボタンをクリックすると検索結果画面へ遷移します。 -
6[最新情報]直近で登録されたアイテム5件が表示されます。
7[TOP]クリックすると最新情報画面に遷移します。
8[CONTACT]クリックするとお問い合わせ画面へ遷移します。
+- 表 2-1 最新情報画面 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[]アイコン +

クリックすると最新情報画面に遷移します。

2[]プルダウンリスト言語の切り替えが出来ます。
+ 切替はja（日本語）とen（英語）の二種類です。
3[]ボタン／
[]ボタン + 		クリックすると[ログイン]もしくは[ログアウト]画面へ遷移します。
4[]ボタンクリックするとインデックス一覧を表示します。
5[検索フォーム]アイテムを検索することが出来ます。
+ []ボタンをクリックすると検索結果画面へ遷移します。 +
6[最新情報]直近で登録されたアイテム5件が表示されます。
7[TOP]クリックすると最新情報画面に遷移します。
8[CONTACT]クリックするとお問い合わせ画面へ遷移します。
### 最新情報画面を表示する @@ -238,52 +232,71 @@ #### 画面項目説明 - 図 2-2 ログイン画面
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 2‑2 ログイン画面 項目と説明
項番項目説明
1[]ボタン -

クリックすると最新情報画面に遷移します。

2[メールアドレス]テキストボックス[メールアドレス]の入力欄です。
3[パスワード]テキストボックス[パスワード]の入力欄です。
4[]ボタン[メールアドレス]、[パスワード]が正しく入力されていれば、クリックして[ログイン]することが出来ます。
-どちらかに誤りがある場合はバリデーションが表示され、[ログイン]することは出来ません。 -
+ + +- 表 2-2 ログイン画面 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[]ボタン +

クリックすると最新情報画面に遷移します。

2[Shibbolethログイン]エリア所属機関を選択後、[選択]ボタンを押下すると各IdPのログイン画面に遷移し、Shibbolethログインを実行することが出来ます。
3[メールアドレス]テキストボックス[メールアドレス]の入力欄です。
4[パスワード]テキストボックス[パスワード]の入力欄です。
5[]ボタン[メールアドレス]、[パスワード]が正しく入力されていれば、クリックして[ログイン]することが出来ます。
+ どちらかに誤りがある場合はバリデーションが表示され、[ログイン]することは出来ません。 +
#### 手順 ここでは、未病データベースへ[ログイン]を行う手順を説明します。 +未病データベースへの[ログイン]方法は2種類あります。 + +① Shibbolethログイン + +所属機関のIdPを利用して行うログインです。 + +1. 最新情報画面の[]ボタンをクリックします。 + +2. ログイン画面に遷移します。 + +3. [Shibbolethログイン]エリアで所属機関を選択し、[選択]ボタンをクリックします。 + +4. 選択した所属機関のログイン画面に遷移します。 + +5. ログイン処理を実行し、[ログイン]が完了すると最新情報画面に遷移します。 + +② ローカルログイン + +メールアドレス、パスワードを用いて行うログインです。 + 1. 最新情報画面の[]ボタンをクリックします。 2. ログイン画面に遷移します。 @@ -301,40 +314,36 @@ - 図 2-3 ログアウト画面
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 2‑3 ログアウト画面 項目と説明
項番項目説明
1[]ボタン -

クリックすると最新情報画面に遷移します。

2[]ボタンクリックすると未病データベースから[ログアウト]します。 -
3[]ボタンクリックすると最新情報画面に遷移します。 -
+- 表 2-3 ログアウト画面 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[]ボタン +

クリックすると最新情報画面に遷移します。

2[]ボタンクリックすると未病データベースから[ログアウト]します。 +
3[]ボタンクリックすると最新情報画面に遷移します。 +
#### 手順 @@ -348,7 +357,7 @@ 4. [ログアウト]が完了します。 -## 第３章　アイテムを検索する +## 第３章 アイテムを検索する この章では、アイテムを検索する方法を説明します。 @@ -360,97 +369,93 @@ - 図 3-2 []ボタンのクリックで折りたたみを開いた状態
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 3-1, 3-2 検索フォーム 項目と説明
項番項目説明
1[キーワード検索]テキストボックス -検索したいキーワードを入力します。
-単語と単語を「 」（半角スペース）で区切るとAND検索、
-「OR」、「｜」で区切るとOR検索を行います。
2[]ボタンクリックすると「[キーワード入力]欄」と[詳細検索]欄の入力値で検索を行います。 -
3[]ボタンクリックすると折りたたまれた詳細検索欄が開きます。(図3-2 参照) -
4[フィルター]詳細検索結果を絞り込みします。
-チェックボックスにチェックを入れる等の入力を行うと即時絞り込みを実行します。 -チェックを解除すると即時絞り込みも解除します。 -
5[]ボタンクリックすると[フィルター]による絞り込みを解除します。 -
6[]ボタンクリックすると[詳細検索]および[フィルター]で設定した検索条件のURLをコピーすることが出来ます。 -
7[あいまい検索／完全一致]ラジオボタン[データセットの名称]の検索方法を設定します。
-[あいまい検索]にチェックを入れて検索を行うと部分一致検索を行い、[完全一致]にチェックを入れて検索を行うと完全一致検索を行います。 -
8[]ボタンクリックすると該当の検索条件項目を削除します。
-[データセットの名称の検索方法]、[データセットの名称]は削除出来ません。 -
9[]プルダウンクリックするとプルダウンが開き、検索条件項目を追加することが出来ます。 -
10[]ボタンクリックすると詳細検索欄に入力した内容が解除されます。
-追加または削除した検索条件項目は変動しません。 -
11[]ボタンクリックすると詳細検索欄が折りたたまれます。
-詳細検索の入力内容は保持します。 -
+- 表 3-1, 3-2 検索フォーム 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[キーワード検索]テキストボックス + 検索したいキーワードを入力します。
+ 単語と単語を「 」（半角スペース）で区切るとAND検索、
+ 「OR」、「｜」で区切るとOR検索を行います。
2[]ボタンクリックすると[キーワード入力]欄と[詳細検索]欄の入力値で検索を行います。 +
3[]ボタンクリックすると折りたたまれた詳細検索欄が開きます。(図3-2 参照) +
4[フィルター]詳細検索結果を絞り込みます。
+ チェックボックスにチェックを入れる等の入力を行うと即時絞り込みを実行します。 + チェックを解除すると即時絞り込みも解除します。 +
5[]ボタンクリックすると[フィルター]による絞り込みを解除します。 +
6[]ボタンクリックすると[詳細検索]および[フィルター]で設定した検索条件のURLをコピーすることが出来ます。 +
7[あいまい検索／完全一致]ラジオボタン[データセットの名称]の検索方法を設定します。
+ [あいまい検索]にチェックを入れて検索を行うと部分一致検索を行い、[完全一致]にチェックを入れて検索を行うと完全一致検索を行います。 +
8[]ボタンクリックすると該当の検索条件項目を削除します。
+ [データセットの名称の検索方法]、[データセットの名称]は削除出来ません。 +
9[]プルダウンクリックするとプルダウンが開き、検索条件項目を追加することが出来ます。 +
10[]ボタンクリックすると詳細検索欄に入力した内容が解除されます。
+ 追加または削除した検索条件項目は変動しません。 +
11[]ボタンクリックすると詳細検索欄が折りたたまれます。
+ 詳細検索の入力内容は保持します。 +
### 詳細検索 @@ -504,7 +509,7 @@ ### 検索条件をコピーする -ここでは検索条件のコピーする手順を説明します。 +ここでは検索条件をコピーする手順を説明します。 1. [詳細検索]、[フィルター]で検索結果を絞り込みます。 @@ -521,7 +526,7 @@ - 図 3-12
-4. 外部ページ（Google など）のアドレスバーにコピーした URL を入力します。 +4. ブラウザのアドレスバーにコピーした URL を入力します。 - 図 3-13
@@ -530,7 +535,7 @@ - 図 3-14
-## 第４章　アイテムをダウンロードする +## 第４章 アイテムをダウンロードする この章では、アイテムをダウンロードする画面、および手順を説明します。 @@ -539,69 +544,65 @@ - 図 4-1

※ [フィルター]、[検索／フィルター条件のコピーボタン]については - 「[第３章　アイテムを検索する](#第３章アイテムを検索する)」で説明しているため、本章では割愛します。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 4-1 サマリーテーブル 項目と説明
項番項目説明
1[表示件数]プルダウン -表示する件数を設定出来ます。 -
2[並び順]プルダウン並び順を変更出来ます。 -
3[昇順／降順]ボタン[並び順]プルダウンで選んだ項目を元に昇順／降順に並び替えします。 -
4[検索結果全てをDLする]リンク検索結果を全てtsv形式でダウンロードします。 -
5[データセットの名称]リンクアイテムのタイトルです。
-クリックするとアイテム詳細画面に遷移します。 -
6[あり(添付ファイル件数)]リンクアイテムにファイルが添付されている場合、[あり(添付ファイル件数)]と表示されます。添付ファイルがない場合は[なし]と表示されます。
-クリックするとファイル一覧画面に遷移します。 -
7[ページ数]複数ページがある場合、現在のページ数以外をクリックするとページを移動します。 -
+ 「[第３章 アイテムを検索する](#第３章-アイテムを検索する)」で説明しているため、本章では割愛します。 + +- 表 4-1 サマリーテーブル 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[表示件数]プルダウン + 表示する件数を設定出来ます。 +
2[並び順]プルダウン並び順を変更出来ます。 +
3[昇順／降順]ボタン[並び順]プルダウンで選んだ項目を基に昇順／降順に並び替えします。 +
4[検索結果全てをDLする]リンク検索結果を全てtsv形式でダウンロードします。 +
5[データセットの名称]リンクアイテムのタイトルです。
+ クリックするとアイテム詳細画面に遷移します。 +
6[あり(添付ファイル件数)]リンクアイテムにファイルが添付されている場合、[あり(添付ファイル件数)]と表示されます。添付ファイルがない場合は[なし]と表示されます。
+ クリックするとファイル一覧画面に遷移します。 +
7[ページ数]複数ページがある場合、現在のページ数以外をクリックするとページを移動します。 +
### 検索したアイテムをダウンロードする @@ -625,7 +626,7 @@ - 図 4-5 ダウンロードした tsv ファイルの内容 (アイテムは検索結果と同じ 3 件)
-## 第５章　アイテムの詳細を表示する +## 第５章 アイテムの詳細を表示する この章では、アイテムの詳細を表示する方法を説明します。 @@ -634,97 +635,93 @@ - 図 5-1 アイテム詳細画面
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 5-1 アイテム詳細画面 項目と説明
項番項目説明
1[インデックス]リンク -アイテムが登録されているインデックス名が表示されます。
-クリックするとインデックスに登録されているアイテムの一覧画面に遷移します。 -
2[検索結果リストに戻る]リンククリックすると検索結果画面に遷移します。 -
3[前のアイテムを表示]リンククリックすると前のアイテムの詳細画面に遷移します。 -
4[次のアイテムを表示]リンククリックすると次のアイテムの詳細画面に遷移します。 -
5[サムネイル]アイテムのサムネイルです。 -
6[アイテムの概要]アイテムの概要が表示されます。
7[]ボタンクリックするとファイル一覧画面に遷移します。 -
8[]タブタブを切り替えすることでアイテムに登録されているメタデータを確認出来ます。 -
9[]ボタンクリックすると画面上部へ移動します。 -
10[閲覧数]これまでに閲覧された件数が表示されます。
-[See details]をクリックすると閲覧数の詳細を確認出来ます。 -
11[DLランキング]添付ファイルがある場合、これまでにダウンロードされたランキングが表示されます。
-ファイル名右横の アイコンをクリックするとファイルをダウンロード出来ます。 -
12[エクスポート]アイテムのメタデータのXMLファイル、JSONファイル等を確認することが出来ます。 -
+- 表 5-1 アイテム詳細画面 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[インデックス]リンク + アイテムが登録されているインデックス名が表示されます。
+ クリックするとインデックスに登録されているアイテムの一覧画面に遷移します。 +
2[検索結果リストに戻る]リンククリックすると検索結果画面に遷移します。 +
3[前のアイテムを表示]リンククリックすると前のアイテムの詳細画面に遷移します。 +
4[次のアイテムを表示]リンククリックすると次のアイテムの詳細画面に遷移します。 +
5[サムネイル]アイテムのサムネイルです。 +
6[アイテムの概要]アイテムの概要が表示されます。
7[]ボタンクリックするとファイル一覧画面に遷移します。 +
8[]タブタブを切り替えすることでアイテムに登録されているメタデータを確認出来ます。 +
9[]ボタンクリックすると画面上部へ移動します。 +
10[閲覧数]これまでに閲覧された件数が表示されます。
+ [See details]をクリックすると閲覧数の詳細を確認出来ます。 +
11[DLランキング]添付ファイルがある場合、これまでにダウンロードされたランキングが表示されます。
+ ファイル名右横の アイコンをクリックするとファイルをダウンロード出来ます。 +
12[エクスポート]アイテムのメタデータのXMLファイル、JSONファイル等を確認することが出来ます。 +
### タブの切り替え @@ -756,7 +753,7 @@ ここではリクエストメールについて説明します。 -1. 「ユーザーが未病データベースにログインしていないこと」および「アイテムにフィードバックメールアドレスが登録されていること」の条件を満たす場合、[閲覧数]の下に[リクエストメール]が表示されます。 +1. 「アイテムにリクエストメールアドレスが登録されていること」および「アイテムにGakuNin RDMのプロジェクトURLが登録されていないこと」の条件を満たす場合、[閲覧数]の下に[リクエストメール]が表示されます。 - 図 5-6
@@ -766,20 +763,42 @@ - 図 5-7 リクエストメール 送信フォーム
-3. [送信フォーム]に必要事項を入力のうえ、[送信]ボタンをクリックするとリクエストメールを送信することが出来ます。
（※現在は未実装です） +3. [送信フォーム]に必要事項を入力のうえ、[送信]ボタンをクリックするとリクエストメールを送信することが出来ます。 -### GakuNinRDM +### GakuNin RDM -ここでは GakuNinRDM のデータセットを確認する手順を説明します。 +ここでは GakuNin RDM のデータセットを確認する手順を説明します。 -1. 「ユーザーが未病データベースにログインしていること」および「アイテムにプロジェクト ID が登録されていること」の条件を満たす場合、[閲覧数]の下に[GakuNin RDM]が表示されます。 +1. 「アイテムにGakuNin RDMのプロジェクトURLが登録されていること」の条件を満たす場合、[閲覧数]の下に[GakuNin RDM]が表示されます。 - 図 5-8
-2. []アイコンをクリックすると GakuNinRDM のデータセットを開くことが出来ます。
（※現在は未実装です） +2. []アイコンをクリックすると GakuNin RDM のデータセットを開くことが出来ます。 + +### 閲覧権限のないユーザーがアイテムにアクセスした場合 + +閲覧権限がないユーザーがアイテム詳細画面にアクセスした場合はエラーが表示されます。
+エラー内容はユーザーがログインしているか否かで異なります。 + +1. ユーザーがログイン済みの場合 + + アイテム詳細画面にアクセスすると以下のようなエラーが表示されます。 + + + +2. ユーザーが未ログインの場合 + + アイテム閲覧にログインが必要な旨、およびログイン画面のURLが表示されます。
+ ログイン画面のURLをクリック、または、記載の秒数経過後にログイン画面へ遷移します。 + + -## 第６章　添付ファイルを確認する + 閲覧権限のあるユーザーがログインするとアイテム詳細画面に戻り、アイテムを閲覧することが出来ます。 + + ログインしても閲覧権限がない場合は1.と同様のエラーが表示されます。 + +## 第６章 添付ファイルを確認する この章では添付ファイルの確認方法を説明します。 @@ -788,101 +807,97 @@ - 図 6-1 ファイル一覧画面
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
表 6-1 ファイル一覧画面 項目と説明
項番項目説明
1[表示件数]プルダウン -表示する件数を設定出来ます。 -
2[DL回数統計対象期間]プルダウン[ダウンロード]された回数の統計対象期間を変更出来ます。 -
3[アイテム詳細画面に戻る]リンククリックすると該当の[アイテム詳細画面]に遷移します。 -
4[全件ダウンロード]リンク表示されているファイルを全件ダウンロードします。 -
5[フィルター]表示されているファイルを絞り込みします。 -
6[]ボタン[フィルター]の絞り込みを解除します。
7ファイル一覧テーブルファイルの一覧が表示されます。 -
8[ライセンス]アイコンクリックすると該当の[ライセンス]ページに遷移します。 -
9[]ボタンクリックするとファイルのプレビュー画面が別ウィンドウで開きます。 -
10[]ボタンクリックすると選択したファイルを[ダウンロード]します。 -
11[格納場所URL]ファイルが格納されているURLです。
-クリックすると選択したファイルを[ダウンロード]します。 -
12[]ボタンファイル一覧テーブルで選択したファイルを[ダウンロード]します。
(0件)には選択したファイル件数が入ります。 -
13[ページ数]複数ページがある場合、現在のページ数以外をクリックするとページを移動します。 -
+- 表 6-1 ファイル一覧画面 項目と説明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
項番項目説明
1[表示件数]プルダウン + 表示する件数を設定出来ます。 +
2[DL回数統計対象期間]プルダウン[ダウンロード]された回数の統計対象期間を変更出来ます。 +
3[アイテム詳細画面に戻る]リンククリックすると該当の[アイテム詳細画面]に遷移します。 +
4[全件ダウンロード]リンク表示されているファイルを全件ダウンロードします。 +
5[フィルター]表示されているファイルを絞り込みます。 +
6[]ボタン[フィルター]の絞り込みを解除します。
7ファイル一覧テーブルファイルの一覧が表示されます。 +
8[ライセンス]アイコンクリックすると該当の[ライセンス]ページに遷移します。 +
9[]ボタンクリックするとファイルのプレビュー画面が別ウィンドウで開きます。 +
10[]ボタンクリックすると選択したファイルを[ダウンロード]します。 +
11[格納場所URL]ファイルが格納されているURLです。
+ クリックすると選択したファイルを[ダウンロード]します。 +
12[]ボタンファイル一覧テーブルで選択したファイルを[ダウンロード]します。
(0件)には選択したファイル件数が入ります。 +
13[ページ数]複数ページがある場合、現在のページ数以外をクリックするとページを移動します。 +
### ファイルをプレビューで確認する @@ -913,7 +928,7 @@ ### ファイルをダウンロードする ここではファイルのダウンロード手順を説明します。 -大まかに分けて、3 種類のダウンロード方法があります。 +大きく分けて、3 種類のダウンロード方法があります。 1. [全件ダウンロード](#全件ダウンロード) 2. [選択ダウンロード](#選択ダウンロード) @@ -928,7 +943,7 @@ - 図 6-6
-2. 表示されている 4 件を[ダウンロード]します。 +2. ファイルが[ダウンロード]されます。 - 図 6-7
@@ -950,7 +965,7 @@ - 図 6-10
-3. 選択したファイルを 2 件を[ダウンロード]します。 +3. チェックを入れたファイルが[ダウンロード]されます。 - 図 6-11 ダウンロードしたファイル一覧リスト
diff --git "a/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image78.PNG" "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image78.PNG" new file mode 100644 index 00000000..0b6a204a Binary files /dev/null and "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image78.PNG" differ diff --git "a/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image79.PNG" "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image79.PNG" new file mode 100644 index 00000000..4d182d80 Binary files /dev/null and "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image79.PNG" differ diff --git "a/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image80.PNG" "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image80.PNG" new file mode 100644 index 00000000..a1b582fe Binary files /dev/null and "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image80.PNG" differ diff --git "a/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image81.PNG" "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image81.PNG" new file mode 100644 index 00000000..4b4909b3 Binary files /dev/null and "b/docs/manuals/\346\234\252\347\227\205USER/base/media/media/image81.PNG" differ diff --git a/docs/spec/base/access_control/ADMIN_ADVANCED_01.md b/docs/spec/base/access_control/ADMIN_ADVANCED_01.md new file mode 100644 index 00000000..ef42efdf --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_ADVANCED_01.md @@ -0,0 +1,23 @@ +# アドバンスド + +アドバンスドのアクセスコントロールについて記述します。 + +エンドポイント：/admin/profile_settings/ + +## 目次 + +- [プロフィール編集画面](#プロフィール編集画面) + +## プロフィール編集画面 + +○に合致すれば、プロフィール編集画面の閲覧、および設定値の登録・編集・表示非表示の切り替えを行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_AUTHOR_01.md b/docs/spec/base/access_control/ADMIN_AUTHOR_01.md new file mode 100644 index 00000000..c51479ab --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_AUTHOR_01.md @@ -0,0 +1,53 @@ +# 著者DB管理画面 + +著者DB管理画面のアクセスコントロールについて記述します。 + +## 目次 + +- [編集](#編集) +- [一括出力](#一括出力) +- [一括登録](#一括登録) + + + +## 編集 + +エンドポイント：/admin/authors/ + +表内のいずれかの○に合致すれば、Author IDを表示して追加・編集・削除・統合を行うことが出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|○|○|×|×|×| + + + +## 一括出力 + +エンドポイント：/admin/authors/export/ + +表内のいずれかの○に合致すれば、全件エクスポートを実行出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|○|○|×|×|×| + + + +## 一括登録 + +エンドポイント：/admin/authors/import/ + +表内のいずれかの○に合致すれば、ユーザが著者DBの情報を一括登録出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|○|○|×|×|×| + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_COMMUNITY_01.md b/docs/spec/base/access_control/ADMIN_COMMUNITY_01.md new file mode 100644 index 00000000..648228ae --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_COMMUNITY_01.md @@ -0,0 +1,64 @@ +# コミュニティ管理 + +コミュニティ管理のアクセスコントロールについて記述します。 + +## 目次 + +- [コミュニティ](#コミュニティ) +- [参加リクエスト](#参加リクエスト) +- [注目のコミュニティ](#注目のコミュニティ) + +## コミュニティ + +エンドポイント：/admin/community/ + +表内の○に合致すれば、コミュニティ一覧を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### 閲覧・編集・削除 + +表内のいずれかの○に合致すれば、コミュニティの閲覧・編集・削除を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身が所属する
グループ | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 作成 + +表内の○に合致すれば、コミュニティの作成を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 参加リクエスト + +エンドポイント：/admin/inclusionrequest/ + +表内の○に合致すれば、参加リクエスト一覧を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 注目のコミュニティ + +エンドポイント：/admin/featuredcommunity/ + +表内の○に合致すれば、注目のコミュニティページの以下機能を利用することが出来ます。 + +利用出来る機能：コミュニティ一覧の閲覧、およびコミュニティの作成・閲覧・編集・削除 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_FILES_01.md b/docs/spec/base/access_control/ADMIN_FILES_01.md new file mode 100644 index 00000000..6bc97320 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_FILES_01.md @@ -0,0 +1,103 @@ +# ファイル管理画面 + +ファイル管理画面のアクセスコントロールについて記述します。 + +## 目次 + +- [バケット](#バケット) +- [ファイルインスタンス](#ファイルインスタンス) +- [ロケーション](#ロケーション) +- [マルチパートオブジェクト](#マルチパートオブジェクト) +- [オブジェクトバージョン](#オブジェクトバージョン) + +## バケット + +エンドポイント：/admin/bucket/ + +表内のいずれかの○に合致すれば、バケットページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +表内のいずれかの○に合致すれば、バケットの設定値の表示、作成、編集することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## ファイルインスタンス + +エンドポイント：/admin/fileinstance/ + +表内のいずれかの○に合致すれば、ファイルインスタンスページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +表内のいずれかの○に合致すれば、ファイルインスタンスの設定値を表示、Run fixity checkすることが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## ロケーション + +エンドポイント：/admin/location/ + +表内のいずれかの○に合致すれば、ロケーションページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +表内のいずれかの○に合致すれば、ロケーションの設定値を表示することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +表内のいずれかの○に合致すれば、ロケーションの設定値を作成、削除することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## マルチパートオブジェクト + +エンドポイント：/admin/multipartobject/ + +表内のいずれかの○に合致すれば、マルチパートオブジェクトページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +表内のいずれかの○に合致すれば、マルチパートオブジェクトの設定値を表示することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## オブジェクトバージョン + +エンドポイント：/admin/objectversion/ + +表内のいずれかの○に合致すれば、オブジェクトバージョンページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +表内のいずれかの○に合致すれば、オブジェクトバージョンの設定値を表示することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_INDEXTREE_01.md b/docs/spec/base/access_control/ADMIN_INDEXTREE_01.md new file mode 100644 index 00000000..120b9b25 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_INDEXTREE_01.md @@ -0,0 +1,78 @@ +# インデックスツリー管理 + +インデックスツリー管理のアクセスコントロールについて記述します。 + +## 目次 + +- [ツリー編集](#ツリー編集) +- [雑誌情報](#雑誌情報) +- [カスタムソート](#カスタムソート) + +## ツリー編集 + +エンドポイント：/admin/indexedit/ + +○ に合致すれば、ツリー編集ページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インデックスツリーにインデックスが表示されるか、およびインデックス編集可否 + +○ に合致すればインデックスツリーにインデックスが表示され、インデックスを編集することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 +あるコミュニティ管理者に管理されているインデックスとは、当該のコミュニティ管理者が管理するコミュニティの設定で「Index」に指定されているインデックスと、その子インデックスを指します。 + +## 雑誌情報 + +エンドポイント：/admin/indexjournal/ + +○ に合致すれば、雑誌情報ページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インデックスツリーにインデックスが表示されるか、および雑誌情報設定可否 + +○ に合致すればインデックスツリーにインデックスが表示され、インデックスの雑誌情報を設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 +あるコミュニティ管理者に管理されているインデックスとは、当該のコミュニティ管理者が管理するコミュニティの設定で「Index」に指定されているインデックスと、その子インデックスを指します。 + +## カスタムソート + +エンドポイント：/admin/items/custom_sort/ + +○ に合致すれば、カスタムソートページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インデックスツリーにインデックスが表示されるか、およびカスタムソート設定可否 + +○ に合致すればインデックスツリーにインデックスが表示され、インデックスにカスタムソートを設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 +あるコミュニティ管理者に管理されているインデックスとは、当該のコミュニティ管理者が管理するコミュニティの設定で「Index」に指定されているインデックスと、その子インデックスを指します。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_ITEM_01.md b/docs/spec/base/access_control/ADMIN_ITEM_01.md new file mode 100644 index 00000000..1da93889 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_ITEM_01.md @@ -0,0 +1,146 @@ +# アイテム管理 + +アイテム管理のアクセスコントロールについて記述します。 + +## 目次 + +- [一括更新](#一括更新) +- [一括エクスポート](#一括エクスポート) +- [インポート](#インポート) +- [RO-Crateインポート](#ro-crateインポート) + +## 一括更新 + +エンドポイント：/admin/items/bulk/update/ + +○に合致すれば、一括更新ページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インデックスツリーエリア + +○に合致すれば、一括更新ページのインデックスツリーエリアにインデックス一覧が表示されます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +#### アイテムリストエリア + +○に合致すれば、一括更新ページのアイテムリストエリアにアイテムが表示されます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +#### 更新機能 + +○に合致すれば、一括更新ページの更新機能が利用出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +## 一括削除 + +エンドポイント：/admin/items/bulk/delete/ + +○に合致すれば、一括削除ページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インデックスツリーエリア + +○に合致すれば、一括削除ページのインデックスツリーエリアにインデックス一覧が表示されます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +#### 削除機能 + +○に合致すれば、一括削除ページの削除機能が利用出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +## 一括エクスポート + +エンドポイント：/admin/items/bulk-export/ + +○に合致すれば、一括エクスポートページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### エクスポート機能 + +○に合致すれば、一括エクスポートページのエクスポート機能が利用出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +## インポート + +エンドポイント：/admin/items/import/ + +○に合致すれば、インポートページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### インポート機能 + +○に合致すれば、インポートページのインポート機能が利用出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +## RO-Crateインポート + +エンドポイント：/admin/items/rocrate_import/ + +○に合致すれば、RO-Crateインポートページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### RO-Crateインポート機能 + +○に合致すれば、RO-Crateインポートページのインポート機能が利用出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_ITEM_TYPE_01.md b/docs/spec/base/access_control/ADMIN_ITEM_TYPE_01.md new file mode 100644 index 00000000..6157e4e3 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_ITEM_TYPE_01.md @@ -0,0 +1,116 @@ +# アイテムタイプ管理 + +アイテムタイプ管理のアクセスコントロールについて記述します。 + +## 目次 + +- [メタデータ](#メタデータ) +- [マッピング](#マッピング) +- [OAIスキーマ](#oaiスキーマ) +- [プロパティ](#プロパティ) +- [RO-Crateマッピング](#ro-crateマッピング) +- [JSON-LDマッピング](#json-ldマッピング) + +## メタデータ + +エンドポイント：/admin/itemtypes + +○に合致すれば、メタデータページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +○に合致すれば、メタデータページの以下機能を利用することが出来ます。 + +利用できる機能：アイテムタイプの新規登録、コピー、バージョンアップ、削除、インポート、エクスポート、削除済みアイテムタイプの復元 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## マッピング + +エンドポイント：/admin/itemtypes/mapping + +○に合致すれば、マッピングページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +○に合致すれば、アイテムタイプのマッピング設定機能を利用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## OAIスキーマ + +エンドポイント：/admin/schemasettings + +○に合致すれば、OAIスキーマページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +○に合致すれば、スキーマの追加・削除機能を利用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## プロパティ + +エンドポイント：/admin/itemtypes/properties + +○に合致すれば、プロパティページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +○に合致すれば、プロパティの追加・編集機能を利用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## RO-Crateマッピング + +エンドポイント：/admin/itemtypes/rocrate_mapping + +○に合致すれば、RO-Crateマッピングページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +○に合致すれば、アイテムタイプにRO-Crateマッピングを設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## JSON-LDマッピング + +エンドポイント：/admin/jsonld-mapping + +○に合致すれば、JSON-LDマッピングページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +○に合致すれば、アイテムタイプにJSON-LDマッピングを設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_LOGS_01.md b/docs/spec/base/access_control/ADMIN_LOGS_01.md new file mode 100644 index 00000000..d7b0214a --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_LOGS_01.md @@ -0,0 +1,32 @@ +# ログ管理 + +ログ管理画面のアクセスコントロールについて記述します。 + +エンドポイント：/admin/logs/export/ + +## 目次 + +- [エクスポート](#エクスポート) + + + +## エクスポート + +表内のいずれかの○に合致すれば、エクスポートページを閲覧することが出来ます。 + + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|○|×|×|×|×| + +表内のいずれかの○に合致すれば、エクスポートを実行出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|○|×|×|×|×| + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_MAINTENANCE_01.md b/docs/spec/base/access_control/ADMIN_MAINTENANCE_01.md new file mode 100644 index 00000000..2d7eb608 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_MAINTENANCE_01.md @@ -0,0 +1,35 @@ +# メンテナンス + +メンテナンス画面のアクセスコントロールについて記述します。 + +エンドポイント：/admin/reindex_es/ + +## 目次 + +- [ElasticSearchインデックス](#elasticsearchインデックス) + + + +## ElasticSearchインデックス + +表内のいずれかの○に合致すれば、ElasticSearchインデックスページを閲覧することが出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|×|×|×|×|×| + +表内のいずれかの○に合致すれば、「アイテムインデックスの再作成」または「アイテムの再インデックス」を実行することが出来ます。 + +※「アイテムインデックスの再作成」と「アイテムの再インデックス」の同時実行は不可能です。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|×|×|×|×|×| + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_OAI_PMH_01.md b/docs/spec/base/access_control/ADMIN_OAI_PMH_01.md new file mode 100644 index 00000000..1efc30ca --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_OAI_PMH_01.md @@ -0,0 +1,63 @@ +# OAI-PMH + +OAI-PMHのアクセスコントロールについて記述します。 + +## 目次 + +- [ハーベスト](#ハーベスト) +- [Identify](#identify) +- [set](#set) + +## ハーベスト + +エンドポイント：/admin/harvestsettings + +○に合致すれば、ハーベストページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### 設定値の作成 + +いずれかの○に合致すれば、ハーベストの設定値を作成することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 管理対象コミュニティに
対象インデックスが
設定されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 作成済み設定値の一覧表示、設定値の編集・削除 + +いずれかの○に合致すれば、作成済み設定値の一覧表示、設定値の編集・削除を行うことが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者ロール：
コミュニティ管理者 | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## Identify + +エンドポイント：/admin/identify + +○に合致すれば、Identifyページの閲覧、および設定値の編集が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## set + +エンドポイント：/admin/oaiset + +○に合致すれば、setページの閲覧、および設定値の作成・編集が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_RECORDS_01.md b/docs/spec/base/access_control/ADMIN_RECORDS_01.md new file mode 100644 index 00000000..192cb047 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_RECORDS_01.md @@ -0,0 +1,40 @@ +# レコード管理画面 + +レコード管理画面のアクセスコントロールについて記述します。 + +## 目次 + +- [永続識別子](#永続識別子) +- [レコードメタデータ](#レコードメタデータ) + + + +## 永続識別子 + +エンドポイント：/admin/persistentidentifier/ + +表内のいずれかの○に合致すれば、永続識別子ページの閲覧およびレコードの閲覧が出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|×|×|×|×|×| + + + +## レコードメタデータ + +エンドポイント：/admin/recordmetadata/ + +表内のいずれかの○に合致すれば、レコードメタデータページの閲覧およびレコードの閲覧、削除が出来ます。 + +|ロール|システム
管理者|リポジトリ
管理者|コミュニティ
管理者|登録ユーザー|一般ユーザー|ゲスト
(未ログイン)| +|---|---|---|---|---|---|---| +|利用可否|○|×|×|×|×|×| + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_RESOURCE_SYNC_01.md b/docs/spec/base/access_control/ADMIN_RESOURCE_SYNC_01.md new file mode 100644 index 00000000..e730a7cb --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_RESOURCE_SYNC_01.md @@ -0,0 +1,72 @@ +# Resource Sync + +Resource Syncのアクセスコントロールについて記述します。 + +## 目次 + +- [Resource List](#resource-list) +- [Change List](#change-list) +- [Resync](#resync) + +## Resource List + +エンドポイント：/admin/resource_list/ + +○に合致すれば、Resource Listページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### Resource Listの作成・閲覧・削除・編集 + +いずれかの○に合致すれば、Resource Listを作成、閲覧、削除、編集することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 「Repository」に
自身の所属する
コミュニティが
設定されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## Change List + +エンドポイント：/admin/change_list/ + +○に合致すれば、Change Listページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### Change Listの作成・閲覧・削除・編集 + +いずれかの○に合致すれば、Change Listを作成、閲覧、削除、編集することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 「Repository」に
自身の所属する
コミュニティが
設定されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## Resync + +エンドポイント：/admin/resync/ + +○に合致すれば、Resyncページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### Resyncの作成・閲覧・削除・編集 + +いずれかの○に合致すれば、Resyncを作成、閲覧、削除、編集することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 「Target Index」に
自身の所属する
コミュニティが
設定されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_SETTING_01.md b/docs/spec/base/access_control/ADMIN_SETTING_01.md new file mode 100644 index 00000000..c87dadb0 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_SETTING_01.md @@ -0,0 +1,265 @@ +# 設定画面 + +設定画面のアクセスコントロールについて記述します。 + +## 目次 + +- [アイテム表示](#アイテム表示) +- [アクティビティ一覧表示](#アクティビティ一覧表示) +- [インデックスリンク表示](#インデックスリンク表示) +- [言語表示](#言語表示) +- [PDFカバーページ表示](#pdfカバーページ表示) +- [ランキング表示](#ランキング表示) +- [統計情報表示](#統計情報表示) +- [画面背景色](#画面背景色) +- [識別子](#識別子) +- [アイテム一括出力](#アイテム一括出力) +- [ログ解析](#ログ解析) +- [検索設定](#検索設定) +- [ファセット検索](#ファセット検索) +- [サイト情報](#サイト情報) +- [サイトライセンス](#サイトライセンス) +- [サイトマップ](#サイトマップ) +- [メール送信](#メール送信) +- [WebAPIアカウント](#webapiアカウント) +- [ファイルプレビュー](#ファイルプレビュー) +- [Shibboleth](#shibboleth) +- [制限公開](#制限公開) +- [CRIS連携](#cris連携) +- [その他](#その他) + +## アイテム表示 + +エンドポイント：/admin/itemsetting/ + +表内のいずれかの○に合致すれば、アイテム表示・検索に関する設定をすることが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## アクティビティ一覧表示 + +エンドポイント：/admin/activity/ + +表内のいずれかの○に合致すれば、アクティビティ一覧表示を設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## インデックスリンク表示 + +エンドポイント：/admin/indexlink/ + +表内のいずれかの○に合致すれば、インデックスリンクを表示するか否かを設定することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 言語表示 + +エンドポイント：/admin/language/ + +表内のいずれかの○に合致すれば、ユーザーが選択可能な表示言語を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## PDFカバーページ表示 + +エンドポイント：/admin/pdfcoverpage/ + +表内のいずれかの○に合致すれば、PDFカバーページについて設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## ランキング表示 + +エンドポイント：/admin/rankingsettings/ + +表内のいずれかの○に合致すれば、ランキングの閲覧を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 統計情報表示 + +エンドポイント：/admin/statssettings/ + +表内のいずれかの○に合致すれば、アイテムの利用統計情報の閲覧を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 画面背景色 + +エンドポイント：/admin/stylesetting/ + +表内のいずれかの○に合致すれば、画面背景色表示を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 識別子 + +エンドポイント：/admin/identifier/ + +表内のいずれかの○に合致すれば、識別子を作成、編集出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## アイテム一括出力 + +エンドポイント：/admin/itemexportsettings/ + +表内のいずれかの○に合致すれば、アイテム一括出力の可否を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## ログ解析 + +エンドポイント：/admin/loganalysissetting/ + +表内のいずれかの○に合致すれば、利用統計の集計除外を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 検索設定 + +エンドポイント：/admin/searchsettings/ + +表内のいずれかの○に合致すれば、検索設定を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## ファセット検索 + +エンドポイント：/admin/facet-search/ + +表内のいずれかの○に合致すれば、ファセット検索機能を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## サイト情報 + +エンドポイント：/admin/site_info/ + +表内のいずれかの○に合致すれば、サイトの情報を登録出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## サイトライセンス + +エンドポイント：/admin/sitelicensesettings/ + +表内のいずれかの○に合致すれば、サイトライセンスの設定が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## サイトマップ + +エンドポイント：/admin/sitemap/ + +表内のいずれかの○に合致すれば、サイトマップを作成出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## メール送信 + +エンドポイント：/admin/mail/ + +表内のいずれかの○に合致すれば、送信元の情報を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## WebAPIアカウント + +エンドポイント：/admin/webapiaccount/ + +表内のいずれかの○に合致すれば、Web APIのアカウント情報を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## ファイルプレビュー + +エンドポイント：/admin/filepreview/ + +表内のいずれかの○に合致すれば、PDFファイルへの変換時の設定が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## Shibboleth + +エンドポイント：/admin/shibboleth/ + +表内のいずれかの○に合致すれば、Shibbolethの設定が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 制限公開 + +エンドポイント：/admin/restricted_access/ + +表内のいずれかの○に合致すれば、制限公開に関する機能を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | × | × | × | × | × | + +## CRIS連携 + +エンドポイント：/admin/cris_linkage/ + +表内のいずれかの○に合致すれば、CRIS連携に関する機能を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## その他 + +エンドポイント：/admin/others/ + +表内のいずれかの○に合致すれば、その他の運用設定を設定出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| :------: | :----------------: | :------------------: | :--------------------: | :----------: | :----------: | :--------------------: | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_STATISTICS_01.md b/docs/spec/base/access_control/ADMIN_STATISTICS_01.md new file mode 100644 index 00000000..e7c7314d --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_STATISTICS_01.md @@ -0,0 +1,75 @@ +# 統計 + +統計のアクセスコントロールについて記述します。 + +## 目次 + +- [運用レポート](#運用レポート) +- [フィードバックメール](#フィードバックメール) +- [サイトライセンス](#サイトライセンス) + +## 運用レポート + +エンドポイント：/admin/report/ + +表内の○に合致すれば、運用レポートページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### 「コミュニティ」の選択肢にコミュニティが表示されるか、および機能の使用可否 + +いずれかの○に合致すればコミュニティの選択肢にコミュニティが表示され、運用レポート機能を使用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するコミュニティに限ります。 + +## フィードバックメール + +エンドポイント：/admin/feedbackmail/ + +表内の○に合致すれば、フィードバックメールページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### 「リポジトリ」の選択肢にコミュニティが表示されるか、および機能の使用可否 + +いずれかの○に合致すればリポジトリの選択肢にコミュニティが表示され、フィードバックメール機能を使用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するコミュニティに限ります。 + +## サイトライセンス + +エンドポイント：/admin/sitelicensesendmail/ + +表内の○に合致すれば、サイトライセンスページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### 「コミュニティ」の選択肢にコミュニティが表示されるか、および機能の使用可否 + +表内のいずれかの○に合致すれば、コミュニティの選択肢にコミュニティが表示され、サイトライセンス機能を使用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するコミュニティに限ります。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_SWORD_API_01.md b/docs/spec/base/access_control/ADMIN_SWORD_API_01.md new file mode 100644 index 00000000..e8f8ec7c --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_SWORD_API_01.md @@ -0,0 +1,52 @@ +# SWORD API + +SWORD APIのアクセスコントロールについて記述します。 + +## 目次 + +- [TSV/XML](#tsvxml) +- [JSON-LD](#json-ld) + +## TSV/XML + +エンドポイント：/admin/swordapi/ + +○に合致すれば、TSV/XMLページの閲覧、および設定値の変更を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## JSON-LD + +エンドポイント：/admin/swordapi/jsonld/ + +○に合致すれば、JSON-LDページの閲覧、および設定の新規作成を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +#### 設定の閲覧・編集・削除 + +いずれかの○に合致すれば、JSON-LDの設定の閲覧・編集・削除を行うことが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身が作成した
レコード | ○ | ○ | × | × | × | × | +| 自身が作成した
レコード以外 | ○ | × | × | × | × | × | + +#### アプリケーションの表示 + +いずれかの○に合致すれば、設定を作成・編集時、「アプリケーション」の選択肢にアプリケーションが表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身が作成した
アプリケーション | ○ | ○ | × | × | × | × | +| 自身が作成した
アプリケーション以外 | × | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_USER_01.md b/docs/spec/base/access_control/ADMIN_USER_01.md new file mode 100644 index 00000000..2eb28cc5 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_USER_01.md @@ -0,0 +1,169 @@ +# ユーザー管理 + +ユーザー管理のアクセスコントロールについて記述します。 + +## 目次 + +- [アクセス：ロール](#アクセスロール) +- [アクセス：システム](#アクセスシステム) +- [アクセス：ユーザー](#アクセスユーザー) +- [連結アカウント識別子](#連結アカウント識別子) +- [連結アカウントトークン](#連結アカウントトークン) +- [連結アカウント](#連結アカウント) +- [OAuthアプリケーショントークン](#oauthアプリケーショントークン) +- [OAuthアプリケーション](#oauthアプリケーション) +- [ロール](#ロール) +- [セッションアクティビティ](#セッションアクティビティ) +- [ユーザー](#ユーザー) +- [ユーザープロファイル](#ユーザープロファイル) + +## アクセス：ロール + +エンドポイント：/admin/actionroles/ + +○に合致すれば、アクセス：ロールページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## アクセス：システム + +エンドポイント：/admin/actionsystemroles/ + +○に合致すれば、アクセス：システムページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## アクセス：ユーザー + +エンドポイント：/admin/actionusers/ + +○に合致すれば、アクセス：ユーザーページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 連結アカウント識別子 + +エンドポイント：/admin/useridentity/ + +○に合致すれば、連結アカウント識別子ページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 連結アカウントトークン + +エンドポイント：/admin/remotetoken/ + +○に合致すれば、連結アカウントトークンページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 連結アカウント + +エンドポイント：/admin/remoteaccount/ + +○に合致すれば、連結アカウントページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## OAuthアプリケーショントークン + +エンドポイント：/admin/token/ + +○に合致すれば、OAuthアプリケーショントークンページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## OAuthアプリケーション + +エンドポイント：/admin/client/ + +○に合致すれば、OAuthアプリケーションページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## ロール + +エンドポイント：/admin/role/ + +○に合致すれば、ロールページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## セッションアクティビティ + +エンドポイント：/admin/sessionactivity/ + +○に合致すれば、セッションアクティビティページの閲覧、および各種操作を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## ユーザー + +エンドポイント：/admin/user/ + +○に合致すれば、ユーザーページの閲覧、およびレコードの閲覧・削除を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### ユーザーの閲覧・編集・削除 + +いずれかの○に合致すれば、ユーザーの閲覧・編集・削除を行うことが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身が管理する
コミュニティに
所属するユーザ | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### ユーザーの作成 + +○に合致すれば、ユーザーの作成を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## ユーザープロファイル + +エンドポイント：/admin/userprofile/ + +○に合致すれば、ユーザープロファイルページの閲覧、およびレコードの閲覧を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +#### レコードの編集 + +○に合致すれば、レコードの編集を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_WEB_DESIGN_01.md b/docs/spec/base/access_control/ADMIN_WEB_DESIGN_01.md new file mode 100644 index 00000000..3bd72689 --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_WEB_DESIGN_01.md @@ -0,0 +1,56 @@ +# ウェブデザイン管理 + +ウェブデザイン管理のアクセスコントロールについて記述します。 + +## 目次 + +- [ウィジェット](#ウィジェット) +- [ページレイアウト](#ページレイアウト) + +## ウィジェット + +エンドポイント：/admin/widgetitem/ + +○に合致すれば、ウィジェットページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### ウィジェットページの機能 + +いずれかの○に合致すれば、以下のウィジェットページの機能を利用することが出来ます。 + +利用出来る機能：ウィジェットが一覧に表示される、ウィジェットの作成・閲覧・編集・削除 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ウィジェットの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## ページレイアウト + +エンドポイント：/admin/widgetdesign/ + +○に合致すれば、ページレイアウトページを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### ページレイアウトページの機能 + +いずれかの○に合致すれば、以下のページレイアウトページの機能を利用することが出来ます。 + +利用出来る機能：「Repository」の選択肢にコミュニティが表示される、ページレイアウトの保存 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身の管理する
コミュニティ | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/ADMIN_WORKFLOW_01.md b/docs/spec/base/access_control/ADMIN_WORKFLOW_01.md new file mode 100644 index 00000000..f3c7a5da --- /dev/null +++ b/docs/spec/base/access_control/ADMIN_WORKFLOW_01.md @@ -0,0 +1,176 @@ +# ワークフロー管理 + +ワークフロー管理のアクセスコントロールについて記述します。 + +## 目次 + +- [フロー](#フロー) + - [フロー一覧](#フロー一覧) + - [フロー作成](#フロー作成) + - [フロー編集](#フロー編集) +- [ワークフロー](#ワークフロー) + - [ワークフロー一覧](#ワークフロー一覧) + - [ワークフロー作成](#ワークフロー作成) + - [ワークフロー編集](#ワークフロー編集) +- [ワークスペース設定](#ワークスペース設定) + +## フロー + +### フロー一覧 + +エンドポイント：/admin/flowsetting/ + +○に合致すれば、フロー一覧画面を閲覧出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### フロー表示 + +いずれかの○に合致すれば、フロー一覧にフローが表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| フローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +### フロー作成 + +エンドポイント：/admin/flowsetting/0 + +○に合致すればフロー作成を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +### フロー編集 + +エンドポイント：/admin/flowsetting/<フローのuuid> + +#### 編集 + +フロー編集機能を利用するには、2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であれば機能を利用出来ます。 + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| フローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| フローが
「利用申請フラグ：有効」 | ○ | × | × | × | × | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +#### 削除 + +フロー削除機能を利用するには、2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であれば機能を利用出来ます。 + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| フローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| フローが
ワークフローに
登録されている | × | × | × | × | × | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +## ワークフロー + +### ワークフロー一覧 + +エンドポイント：/admin/workflowsetting/ + +○に合致すれば、ワークフロー一覧画面を閲覧出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +#### ワークフロー表示 + +いずれかの○に合致すれば、ワークフロー一覧にワークフローが表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +### ワークフロー作成 + +エンドポイント：/admin/workflowsetting/0 + +○に合致すればワークフロー作成を行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +### ワークフロー編集 + +エンドポイント：/admin/workflowsetting/<フローのuuid> + +#### 編集 + +いずれかの○に合致すれば、ワークフロー編集機能を利用出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 削除 + +ワークフロー削除機能を利用するには、2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であれば機能を利用出来ます。 + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローが
アクティビティ
で使用中 | × | × | × | × | × | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +#### 利用申請フラグ + +いずれかの○に合致すれば、ワークフロー作成、および編集時に利用申請フラグを有効にする選択肢が表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | × | × | × | × | × | +| 上記以外 | ○ | × | × | × | × | × | + +#### フロー表示 + +いずれかの○に合致すれば、ワークフロー作成、および編集時のフロー選択で選択肢にフローが表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフローの
「Repository」に
自身の管理する
コミュニティが
登録されている | ○ | ○ | ○ | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## ワークスペース設定 + +エンドポイント：/admin/workspaceworkflowsetting/ + +○に合致すれば、ワークスペース設定画面を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_ACTIVITY_01.md b/docs/spec/base/access_control/API_ACTIVITY_01.md new file mode 100644 index 00000000..1086f931 --- /dev/null +++ b/docs/spec/base/access_control/API_ACTIVITY_01.md @@ -0,0 +1,50 @@ +# アクティビティ + +アクティビティに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [POST /api/depositactivity](#post-apidepositactivity) +- [GET /api/depositactivity/\](#get-apidepositactivityactivity_id) +- [DELETE /api/depositactivity/\](#delete-apidepositactivityactivity_id) + + + +## POST /api/depositactivity + +表内のいずれかの○に合致すれば、ワークフローを作成することが出来ます。 + +| トークン | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activity
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + + + +## GET /api/depositactivity/\ + +表内のいずれかの○に合致すれば、指定したアクティビティIDのアクティビティの状態を取得することが出来ます。 + +| トークン | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activity
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + + + +## DELETE /api/depositactivity/\ + +表内のいずれかの○に合致すれば、指定したアクティビティIDのアクティビティを中断することが出来ます。 + +| トークン | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activity
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_AUTHOR_01.md b/docs/spec/base/access_control/API_AUTHOR_01.md new file mode 100644 index 00000000..e0636936 --- /dev/null +++ b/docs/spec/base/access_control/API_AUTHOR_01.md @@ -0,0 +1,78 @@ +# 著者 + +著者に関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/authors](#get-apiversionauthors) +- [POST /api/\/authors](#post-apiversionauthors) +- [PUT /api/\/authors/\](#put-apiversionauthorsidentifier) +- [DELETE /api/\/authors/\](#delete-apiversionauthorsidentifier) +- [GET /api/\/authors/count](#get-apiversionauthorscount) + + + +## GET /api/\/authors + +表内のいずれかの○に合致すれば、著者DBの著者を検索することが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
author:read
がある | ○ | ○ | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + + + + +## POST /api/\/authors + +表内のいずれかの○に合致すれば、著者DBに著者を追加することが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
author:read
がある | ○ | ○ | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + + + +## PUT /api/\/authors/\ + +表内のいずれかの○に合致すれば、著者DBの著者を編集することが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
author:update
がある | ○ | ○ | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## DELETE /api/\/authors/\ + +表内のいずれかの○に合致すれば、著者DBの著者を削除することが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
author:delete
がある | ○ | ○ | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + + + +## GET /api/\/authors/count + +表内のいずれかの○に合致すれば、著者DBの著者数を取得することが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_FILE_01.md b/docs/spec/base/access_control/API_FILE_01.md new file mode 100644 index 00000000..4aeec5dd --- /dev/null +++ b/docs/spec/base/access_control/API_FILE_01.md @@ -0,0 +1,183 @@ +# ファイル + +ファイルに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/ranking//files](#get-apiversionrankingpid_valuefiles) +- [GET /api/\/records//files/\](#get-apiversionrecordspid_valuefilesfilename) +- [GET /api/\/records//files/\/stats](#get-apiversionrecordspid_valuefilesfilenamestats) +- [GET /api/\/records//files/all](#get-apiversionrecordspid_valuefilesall) +- [POST /api/\/records//files/selected](#post-apiversionrecordspid_valuefilesselected) +- [GET /api/\/ranking/](#get-apiversionrankingranking_type) + +## GET /api/\/ranking//files + +#### APIの使用 + +いずれかの○に合致すれば、ファイルのランキング情報を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
ranking:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### ランキングのファイル表示可否 + +ファイルAPIにおける[ファイル閲覧権限](#ファイル閲覧権限)があれば、ランキングにファイルが表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイル閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | ○ | +| ファイル閲覧権限：
なし | - | - | × | × | × | × | + +## GET /api/\/records//files/\ + +#### APIの使用 + +いずれかの○に合致すれば、ファイルを取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### ファイル取得可否 + +ファイルAPIにおける[ファイル閲覧権限](#ファイル閲覧権限)があれば、ファイルを取得出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイル閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | ○ | +| ファイル閲覧権限：
なし | - | - | × | × | × | × | + +## GET /api/\/records//files/\/stats + +#### APIの使用 + +いずれかの○に合致すれば、レコード統計を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
file:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### 統計取得可否 + +ファイルAPIにおける[ファイル閲覧権限](#ファイル閲覧権限)があれば、統計を取得出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイル閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | ○ | +| ファイル閲覧権限：
なし | - | - | × | × | × | × | + +## GET /api/\/records//files/all + +#### APIの使用 + +いずれかの○に合致すれば、全ファイルの一覧情報を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
file:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### 一覧情報にファイルが含まれるか否か + +ファイルAPIにおける[ファイル閲覧権限](#ファイル閲覧権限)があれば、一覧情報にファイルが含まれます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイル閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | ○ | +| ファイル閲覧権限：
なし | - | - | × | × | × | × | + +## POST /api/\/records//files/selected + +#### APIの使用 + +いずれかの○に合致すれば、指定レコードの選択ファイルの一覧を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
file:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### ファイル取得可否 + +ファイルAPIにおける[ファイル閲覧権限](#ファイル閲覧権限)があれば、ファイルを取得出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイル閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | × | +| ファイル閲覧権限：
なし | - | - | × | × | × | × | + +## GET /api/\/ranking/ + +#### APIの使用 + +いずれかの○に合致すれば、ランキング情報を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
ranking:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### ランキングにアイテム表示可否 + +ユーザー画面のランキング(/items/ranking)でアイテムがランキングに表示される条件と同一の条件を満たしていればアイテムが表示されます。
+[ランキング表示](USER_ITEM_RANKING_01.md#ランキング表示)を参照ください。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ランキング表示：
可 | ○ | ○ | ○ | ○ | ○ | ○ | +| ランキング表示：
不可 | - | - | × | × | × | × | + +※ インデックスの閲覧権限有無は[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## ファイル閲覧権限 + +ファイルAPIにおけるファイル閲覧権限は、以下の2条件のどちらかを満たす必要があります。 + +2条件の一方でも○なら閲覧可、どちらも×なら閲覧不可です。 + +#### 条件1 アイテム閲覧権限(※1)とファイル公開設定 + +条件1-1 アイテム閲覧権限：有 / ファイル公開設定：オープンアクセス、オープンアクセス日を指定する（指定日以降） + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| | ○ | ○ | ○ | ○ | ○ | ○ | + +条件1-2 アイテム閲覧権限：無 / ファイル公開設定：オープンアクセス、オープンアクセス日を指定する（指定日以前・以降）、ログインユーザーのみ、非公開 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| | ○ | ○ | × | × | × | × | + +条件1-3 アイテム閲覧権限：有 / ファイル公開設定：オープンアクセス日を指定する（指定日以前）、非公開 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| | ○ | ○ | ○ | × | × | × | + +条件1-4 アイテム閲覧権限：有 / ファイル公開設定：ログインユーザーのみ + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| | ○ | ○ | ○ | ○ | ○ | × | + +※1 アイテムAPIにおけるアイテム閲覧権限を指します。
+　　[アイテム閲覧権限](API_ITEM_01.md#アイテムapiのアイテム閲覧権限)を参照ください。 + +#### 条件2 アイテム作成者または代理投稿者が自分 + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自分 | ○ | ○ | ○ | ○ | ○ | × | +| 自分以外 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_INDEX_01.md b/docs/spec/base/access_control/API_INDEX_01.md new file mode 100644 index 00000000..9e0ac2db --- /dev/null +++ b/docs/spec/base/access_control/API_INDEX_01.md @@ -0,0 +1,140 @@ +# インデックス + +インデックスに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/tree](#get-apiversiontree) +- [GET /api/\/tree/](#get-apiversiontreeindex_id) +- [GET /api/\/tree/index](#get-apiversiontreeindex) +- [GET /api/\/tree/index/\](#get-apiversiontreeindexindex_id) +- [GET /api/\/tree/index/\/parent](#get-apiversiontreeindexindex_idparent) +- [POST /api/\/tree/index](#post-apiversiontreeindex) +- [PUT /api/\/tree/index/](#put-apiversiontreeindexindex_id) +- [DELETE /api/\/tree/index/](#delete-apiversiontreeindexindex_id) + +## GET /api/\/tree + +表内のいずれかの○に合致すれば、インデックス情報を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
index:read
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。
+　[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## GET /api/\/tree/\ + +表内のいずれかの○に合致すれば、指定したインデックスIDのインデックスツリーを取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
index:read
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。
+　[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## GET /api/\/tree/index + +表内のいずれかの○に合致すれば、インデックス情報を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
index:read
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。
+　[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## GET /api/\/tree/index/\
+ +表内のいずれかの○に合致すれば、指定したインデックスIDのインデックスツリーを取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
index:read
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。
+　[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## GET /api/\/tree/index/\/parent + +表内のいずれかの○に合致すれば、指定したインデックスIDとルートまでの親インデックス一覧を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
index:read
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。
+　[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## POST /api/\/tree/index + +インデックス登録APIを使用するためには2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であればインデックスを新規作成することが出来ます。 + +条件1 作成するインデックスの親 + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身の管理する
インデックス | ○ | ○ | ○ | × | × | × | +| 自身の管理しない
インデックス | ○ | ○ | × | × | × | × | + +条件2 トークンのスコープ + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| index:create
がある | ○ | ○ | ○ | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## PUT /api/\/tree/index/ + +インデックス更新APIを使用するためには2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であれば指定したインデックスを更新することが出来ます。 + +条件1 作成するインデックスの親 + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身の管理する
インデックス | ○ | ○ | ○ | × | × | × | +| 自身の管理しない
インデックス | ○ | ○ | × | × | × | × | + +条件2 トークンのスコープ + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| index:update
がある | ○ | ○ | ○ | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## DELETE /api/\/tree/index/ + +インデックス削除APIを使用するためには2つの条件を満たす必要があります。 + +以下2つの条件の一方でも×なら利用不可、どちらも○であれば指定したインデックスを削除することが出来ます。 + +条件1 自身の管理するインデックスか否か + +| 条件1/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自身の管理する
インデックス | ○ | ○ | ○ | × | × | × | +| 自身の管理しない
インデックス | ○ | ○ | × | × | × | × | + +条件2 トークンのスコープ + +| 条件2/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| index:delete
がある | ○ | ○ | ○ | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_ITEM_01.md b/docs/spec/base/access_control/API_ITEM_01.md new file mode 100644 index 00000000..5be59075 --- /dev/null +++ b/docs/spec/base/access_control/API_ITEM_01.md @@ -0,0 +1,183 @@ +# アイテム + +アイテムに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/records](#get-apiversionrecords) +- [GET /api/records/](#get-apirecords) +- [GET /api/\/records/\](#get-apiversionrecordspid_value) +- [GET /api/\/records/\/stats](#get-apiversionrecordspid_valuestats) +- [POST /api/\/records/list](#post-apiversionrecordslist) +- [GET /api/index/](#get-apiindex) +- [PUT /api/records/](#put-apirecords) + +## GET /api/\/records + +#### APIの使用 + +いずれかの○に合致すれば、アイテムを検索するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### アイテムが検索結果に含まれるか否か + +アイテムが検索結果に含まれるかどうかは、検索画面で検索結果にアイテムが表示されるかどうかと同一条件です。
+[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 条件と合致 | ○ | ○ | ○ | ○ | ○ | × | +| 合致しない | - | - | × | × | × | × | + +## GET /api/records/ + +#### APIの使用 + +いずれかの○に合致すれば、アイテムを検索するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### アイテムが検索結果に含まれるか否か + +アイテムが検索結果に含まれるかどうかは検索画面で検索結果にアイテムが表示されるかどうかと同一条件です。
+[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 条件と合致 | ○ | ○ | ○ | ○ | ○ | × | +| 合致しない | - | - | × | × | × | × | + +## GET /api/\/records/\ + +#### APIの使用 + +いずれかの○に合致すれば、アイテム詳細情報を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### アイテム詳細情報の取得可否 + +アイテムAPIにおける[アイテム閲覧権限](#アイテムapiのアイテム閲覧権限)に応じて、いずれかの○に合致すればアイテム詳細情報が取得出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 閲覧権限：あり | ○ | ○ | ○ | ○ | ○ | × | +| 閲覧権限：なし | × | × | × | × | × | ○ | + +## GET /api/\/records/\/stats + +#### APIの使用 + +いずれかの○に合致すれば、選択期間のアイテム閲覧数を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### アイテム閲覧数取得可否 + +アイテムAPIにおける[アイテム閲覧権限](#アイテムapiのアイテム閲覧権限)に応じて、いずれかの○に合致すればアイテム閲覧数を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 閲覧権限：あり | ○ | ○ | ○ | ○ | ○ | × | +| 閲覧権限：なし | × | × | × | × | × | ○ | + +## POST /api/\/records/list + +#### APIの使用 + +いずれかの○に合致すれば、検索結果の一覧を取得するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### 検索結果一覧にアイテムが含まれるか否か + +アイテムが検索結果に含まれるかどうかは検索画面で検索結果にアイテムが表示されるかどうかと同一条件です。
+[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 条件と合致 | ○ | ○ | ○ | ○ | ○ | × | +| 合致しない | - | - | × | × | × | × | + +## GET /api/index/ + +#### APIの使用 + +いずれかの○に合致すれば、インデックスを検索するAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| インデックス
閲覧権限:
あり | ○ | ○ | ○ | ○ | ○ | ○ | +| インデックス
閲覧権限:
なし | - | - | × | × | × | × | + +※ [インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## PUT /api/records/ + +#### APIの使用 + +いずれかの○に合致すれば、レコードの書き換えをするAPIを使用することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アイテム作成者：
自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：
自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## アイテムAPIのアイテム閲覧権限 + +アイテムAPIにおけるアイテム閲覧権限の条件は以下の通りです。 + +以下、2つの条件の一方でも○なら閲覧可、どちらも×なら閲覧不可です。 + +#### 条件1 アイテム作成者、または代理投稿者 + +| 条件1 / ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 自分 | ○ | ○ | ○ | ○ | ○ | × | +| 自分以外 | ○ | ○ | × | × | × | × | + +#### 条件2 インデックス閲覧権限有無 / アイテムの公開日 / アイテムのPublish Status + +条件 2-1 インデックス閲覧権限：有 / 公開日以降 / Publish Status：公開 の場合 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +条件 2-2 以下のいずれかに当てはまる場合
+① インデックス閲覧権限：有 / 公開日以降 / Publish Status：非公開
+② インデックス閲覧権限：有 / 公開日以前 / Publish Status：公開
+③ インデックス閲覧権限：有 / 公開日以前 / Publish Status：非公開
+④ インデックス閲覧権限：無 / 公開日以降 / Publish Status：公開
+⑤ インデックス閲覧権限：無 / 公開日以降 / Publish Status：非公開
+⑥ インデックス閲覧権限：無 / 公開日以前 / Publish Status：公開
+⑦ インデックス閲覧権限：無 / 公開日以前 / Publish Status：非公開 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | × | × | × | × | + +※ [インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_LOGIN_01.md b/docs/spec/base/access_control/API_LOGIN_01.md new file mode 100644 index 00000000..5a61141c --- /dev/null +++ b/docs/spec/base/access_control/API_LOGIN_01.md @@ -0,0 +1,43 @@ +# ログイン + +ログインに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [POST /api/\/login](#post-apiversionlogin) +- [POST /api/\/logout](#post-apiversionlogout) + + + +## POST /api/\/login + +表内のいずれかの○に合致すれば、ログインAPIへのアクセスおよびログインが出来ます。 + + +| ログイン後のロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| メールアドレス、パスワードが正しい | ○ | ○ | ○ | ○ | ○ | × | +| メールアドレス、パスワードが誤り | × | × | × | × | × | × | + + +## POST /api/\/logout + +表内のいずれかの○に合致すれば、ログアウトAPIへアクセスすることが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +表内のいずれかの○に合致すれば、ログアウトすることが出来ます。 + + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_OA_STATUS_01.md b/docs/spec/base/access_control/API_OA_STATUS_01.md new file mode 100644 index 00000000..f6bd6d95 --- /dev/null +++ b/docs/spec/base/access_control/API_OA_STATUS_01.md @@ -0,0 +1,25 @@ +# OAステータス + +OAステータスに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [POST /api/\/oa_status/callback](#post-apiversionoa_statuscallback) + + + +## POST /api/\/oa_status/callback + +表内のいずれかの○に合致すれば、OAステータスの更新が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
oa_status:update
あり | ○ | ○ | ○ | ○ | ○ | × | +| トークンのスコープに
oa_status:update
なし | × | × | × | × | × | × | + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_OPEN_SEARCH_01.md b/docs/spec/base/access_control/API_OPEN_SEARCH_01.md new file mode 100644 index 00000000..fd540148 --- /dev/null +++ b/docs/spec/base/access_control/API_OPEN_SEARCH_01.md @@ -0,0 +1,33 @@ +# OpenSearch + +OpenSearchに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/opensearch/description.xml](#get-apiopensearchdescriptionxml) +- [GET /api/opensearch/search](#get-apiopensearchsearch) + +## GET /api/opensearch/description.xml + +全てのロールでdescription.xmlを取得することが可能です。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## GET /api/opensearch/search + +全てのロールでOpenSearchによる検索をすることが可能です。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +※ OpenSearchによる検索でアイテムが表示されるかどうかは、検索画面の検索結果にアイテムが表示されるかどうかと同一条件です。
+　[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_REQUEST_MAIL_01.md b/docs/spec/base/access_control/API_REQUEST_MAIL_01.md new file mode 100644 index 00000000..72b62643 --- /dev/null +++ b/docs/spec/base/access_control/API_REQUEST_MAIL_01.md @@ -0,0 +1,62 @@ +# リクエストメール + +リクエストメールに関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/captcha/image](#get-apiversioncaptchaimage) +- [POST /api/\/captcha/validate](#post-apiversioncaptchavalidate) +- [POST /api/\/records/\/request-mail](#post-apiversionrecordspid_valuerequest-mail) + + + +## GET /api/\/captcha/image + +表内のいずれかの○に合致すれば、CAPTCHA画像を取得することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + + + + +## POST /api/\/captcha/validate + +表内のいずれかの○に合致すれば、CAPTCHA結果検証APIへアクセスすることが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +表内のいずれかの○に合致すれば、トークンを取得することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| calculation_result
が正しい | ○ | ○ | ○ | ○ | ○ | ○ | +| calculation_result
が誤り | × | × | × | × | × | × | + + + +## POST /api/\/records/\/request-mail + +表内のいずれかの○に合致すれば、リクエストメール送信APIへアクセスすることが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +表内のいずれかの○に合致すれば、メールを送信することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| authorization_token
が正しい | ○ | ○ | ○ | ○ | ○ | ○ | +| authorization_token
が誤り | × | × | × | × | × | × | + + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_RESTRICTED_ACCESS_01.md b/docs/spec/base/access_control/API_RESTRICTED_ACCESS_01.md new file mode 100644 index 00000000..005a022d --- /dev/null +++ b/docs/spec/base/access_control/API_RESTRICTED_ACCESS_01.md @@ -0,0 +1,89 @@ +# 制限公開 + +制限公開に関するAPIのアクセスコントロールについて記述します。 + +## 目次 + +- [GET /api/\/workflow/activities](#get-apiversionworkflowactivities) +- [POST /api/\/workflow/activities/\/approve](#post-apiversionworkflowactivitiesactivity_idapprove) +- [POST /api/\/workflow/activities/\/throw-out](#post-apiversionworkflowactivitiesactivity_idthrow-out) +- [GET /api/\/records/\/files/\/terms](#get-apiversionrecordspidfilesfilenameterms) +- [POST /api/\/records/\/files/\/application](#post-apiversionrecordspidfilesfilenameapplication) +- [POST /api/\/workflow/activities/\/application](#post-apiversionworkflowactivitiesactivity_idapplication) +- [GET /api/\/records/\/need-restricted-access](#get-apiversionrecordspidneed-restricted-access) + +## GET /api/\/workflow/activities + +表内のいずれかの○に合致すれば、アクティビティの一覧を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activityがある | ○ | ○ | ○ ※1 | ○ ※1 | × | × | +| 上記以外 | × | × | × | × | × | × | + +※1 自身が担当するアクティビティのみ取得することが出来ます。 + +## POST /api/\/workflow/activities/\/approve + +表内の○に合致すれば、承認待ちのアクティビティを承認することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
workflow:approve
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + +## POST /api/\/workflow/activities/\/throw-out + +表内の○に合致すれば、操作中のアクティビティの操作を却下することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
workflow:approve
がある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | × | + +## GET /api/\/records/\/files/\/terms + +表内の○に合致すれば、指定した制限公開ファイルの利用申請を行う際の利用規約を取得することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activityがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +## POST /api/\/records/\/files/\/application + +表内の○に合致すれば、指定した制限公開ファイルの利用申請を開始し、アクティビティの作成を行うことが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activityがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ ※1 | + +※1 ゲストアクティビティが作成されます。
+　　既に同ファイル、同一メールアドレスに紐づくゲストアクティビティが存在する場合は既存アクティビティを使用します。 + +## POST /api/\/workflow/activities/\/application + +表内の○に合致すれば、制限公開ファイルの利用申請ワークフローにおける申請内容の登録を行うことが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
user:activityがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +※ 利用申請ワークフローのみで利用可能で、通常のワークフローアクティビティでは利用出来ません。 + +## GET /api/\/records/\/need-restricted-access + +表内の○に合致すれば、当該ファイルのコンテンツダウンロードに利用申請が必要かどうか判断することが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| --------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| トークンのスコープに
item:readがある | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | × | × | × | × | × | ○ | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/API_SWORD_API_01.md b/docs/spec/base/access_control/API_SWORD_API_01.md new file mode 100644 index 00000000..81b02b29 --- /dev/null +++ b/docs/spec/base/access_control/API_SWORD_API_01.md @@ -0,0 +1,85 @@ +# SWORD API + +SWORD API のアクセスコントロールについて記述します。 + +## 目次 + +- [GET /sword/service-document](#get-swordservice-document) +- [GET /sword/deposit/\](#get-sworddepositrecid) +- [POST /sword/service-document](#post-swordservice-document) ※ +- [PUT /sword/deposit/\](#put-sworddepositrecid) ※ +- [DELETE /sword/deposit/](#delete-sworddeposit) ※ + +※ `weko_swordserver/config.py` の `WEKO_SWORDSERVER_DEPOSIT_ROLE_ENABLE` の値によって使用可能なロールを指定することが出来ます。 +ただし、インデックスの公開状態や投稿権限を無視して投稿可能となります。 + +## GET /sword/service-document + +○ に合致すれば、サービスドキュメントを取得することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +## GET /sword/deposit/\ + +○ に合致すれば、レコードIDを指定してアイテムのステータスドキュメントを取得することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +## POST /sword/service-document + +○ に合致すれば、アイテムを登録することが出来ます。 + +- API使用可否(直接登録) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ------------------------------------------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:create が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + +- API使用可否(ワークフロー経由で登録) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ----------------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:create
**user:activity** が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + +## PUT /sword/deposit/\ + +○ に合致すれば、レコードIDを指定してメタデータやファイルを置換することが出来ます。 + +- API使用可否(直接更新) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ------------------------------------------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:update が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + +- API使用可否(ワークフロー経由で更新) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ----------------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:update
**user:activity** が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + +## DELETE /sword/deposit/ + +○ に合致すれば、レコードIDを指定してアイテムを削除することが出来ます。 + +- API使用可否(直接削除) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ------------------------------------------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:delete が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + +- API使用可否(ワークフロー経由で削除) + | 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | + | ----------------------------------------------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | + | トークンのスコープに
deposit:write
deposit:actions
item:delete
**user:activity** が全て存在 | ○ | ○ | × | × | × | × | + | 上記以外 | × | × | × | × | × | × | + + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/README.md b/docs/spec/base/access_control/README.md new file mode 100644 index 00000000..ecd61232 --- /dev/null +++ b/docs/spec/base/access_control/README.md @@ -0,0 +1,234 @@ +# アクセスコントロール + +## 目次 + +- ユーザ画面 + - [アイテム詳細画面](USER_ITEM_DETAIL_01.md#アイテム詳細画面) + - [アイテム閲覧](USER_ITEM_DETAIL_01.md#アイテム閲覧) + - [アイテム編集](USER_ITEM_DETAIL_01.md#アイテム編集) + - [アイテム削除](USER_ITEM_DETAIL_01.md#アイテム削除) + - [バージョン削除](USER_ITEM_DETAIL_01.md#バージョン削除) + - [公開ステータス変更](USER_ITEM_DETAIL_01.md#公開ステータス変更) + - [リクエストメール](USER_ITEM_DETAIL_01.md#リクエストメール) + - [利用申請](USER_ITEM_DETAIL_01.md#利用申請) + - [エクスポート](USER_ITEM_DETAIL_01.md#エクスポート) + - [OAI-PMH](USER_ITEM_DETAIL_01.md#oai-pmh) + - [Other Formats](USER_ITEM_DETAIL_01.md#other-formats) + - [コミュニティ](USER_ITEM_DETAIL_01.md#コミュニティ) + - [検索画面](USER_ITEM_SEARCH_01.md#検索画面) + - [簡易検索](USER_ITEM_SEARCH_01.md#簡易検索) + - [詳細検索](USER_ITEM_SEARCH_01.md#詳細検索) + - [ファセット検索](USER_ITEM_SEARCH_01.md#ファセット検索) + - [インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限) + - [ファイル](USER_FILES_DETAIL_01.md#ファイル) + - [ファイルダウンロード](USER_FILES_DETAIL_01.md#ファイルダウンロード) + - [ファイル情報](USER_FILES_DETAIL_01.md#ファイル情報) + - [ファイルプレビュー](USER_FILES_DETAIL_01.md#ファイルプレビュー) + - [ファイル置き換え](USER_FILES_DETAIL_01.md#ファイル置き換え) + - [公開バケットへのコピー](USER_FILES_DETAIL_01.md#公開バケットへのコピー) + - [シークレットURL](USER_FILES_DETAIL_01.md#シークレットurl) + - [シークレットURL設定編集機能](USER_FILES_DETAIL_01.md#シークレットurl設定編集機能) + - [作成済みシークレットURL編集機能](USER_FILES_DETAIL_01.md#作成済みシークレットurl編集機能) + - [ワークフローアクティビティ](USER_WORKFLOW_ACTIVITY_01.md#ワークフローアクティビティ) + - [ワークフロー](USER_WORKFLOW_ACTIVITY_01.md#ワークフロー) + - [ToDoタブ](USER_WORKFLOW_ACTIVITY_01.md#todoタブ) + - [Waitタブ](USER_WORKFLOW_ACTIVITY_01.md#waitタブ) + - [Allタブ](USER_WORKFLOW_ACTIVITY_01.md#allタブ) + - [アクティビティ](USER_WORKFLOW_ACTIVITY_01.md#アクティビティ) + - [新規アクティビティ](USER_WORKFLOW_ACTIVITY_01.md#新規アクティビティ) + - [ItemRegistration](USER_WORKFLOW_ACTIVITY_01.md#itemregistration) + - [ItemLink](USER_WORKFLOW_ACTIVITY_01.md#itemlink) + - [IdentifierGrant](USER_WORKFLOW_ACTIVITY_01.md#identifiergrant) + - [Approval](USER_WORKFLOW_ACTIVITY_01.md#approval) + - [インデックス投稿権限](USER_WORKFLOW_ACTIVITY_01.md#インデックス投稿権限) + - [コミュニティ](USER_COMMUNITY_SUBREPOSITORY_01.md#コミュニティ) + - [コミュニティ一覧](USER_COMMUNITY_SUBREPOSITORY_01.md#コミュニティ一覧) + - [コミュニティ画面](USER_COMMUNITY_SUBREPOSITORY_01.md#コミュニティ画面) + - [コンテンツポリシー](USER_COMMUNITY_SUBREPOSITORY_01.md#コンテンツポリシー) + - [ランキング](USER_ITEM_RANKING_01.md#ランキング) + - [ランキング](USER_ITEM_RANKING_01.md#ランキング-1) + - [ランキング表示](USER_ITEM_RANKING_01.md#ランキング表示) + - [アイテムエクスポート](USER_ITEM_EXPORT_01.md#アイテムエクスポート) + - [アイテムエクスポート](USER_ITEM_EXPORT_01.md#アイテムエクスポート-1) + - [アイテムエクスポート機能](USER_ITEM_EXPORT_01.md#アイテムエクスポート機能) + - [アイテムエクスポート機能（ファイルコンテンツ有）](USER_ITEM_EXPORT_01.md#アイテムエクスポート機能ファイルコンテンツ有) + - [アカウント設定画面](USER_ACCOUNT_SETTING_01.md#アカウント設定画面) + - [プロフィール](USER_ACCOUNT_SETTING_01.md#プロフィール) + - [Security](USER_ACCOUNT_SETTING_01.md#security) + - [通知](USER_ACCOUNT_SETTING_01.md#通知) + - [アプリケーション](USER_ACCOUNT_SETTING_01.md#アプリケーション) + - [Groups](USER_ACCOUNT_SETTING_01.md#groups) + - [セッション](USER_ACCOUNT_SETTING_01.md#セッション) + - [Administration](USER_ACCOUNT_SETTING_01.md#administration) + - [Workspace](USER_ACCOUNT_SETTING_01.md#workspace) + - [ワークスペース](USER_WORKSPACE_01.md#ワークスペース) + - [ワークスペース画面](USER_WORKSPACE_01.md#ワークスペース画面) + - [簡易アイテム登録画面](USER_WORKSPACE_01.md#簡易アイテム登録画面) +- 管理画面 + - [アイテムタイプ管理](ADMIN_ITEM_TYPE_01.md#アイテムタイプ管理) + - [メタデータ](ADMIN_ITEM_TYPE_01.md#メタデータ) + - [マッピング](ADMIN_ITEM_TYPE_01.md#マッピング) + - [OAIスキーマ](ADMIN_ITEM_TYPE_01.md#oaiスキーマ) + - [プロパティ](ADMIN_ITEM_TYPE_01.md#プロパティ) + - [RO-Crateマッピング](ADMIN_ITEM_TYPE_01.md#ro-crateマッピング) + - [JSON-LDマッピング](ADMIN_ITEM_TYPE_01.md#json-ldマッピング) + - [アイテム管理](ADMIN_ITEM_01.md#アイテム管理) + - [一括更新](ADMIN_ITEM_01.md#一括更新) + - [一括エクスポート](ADMIN_ITEM_01.md#一括エクスポート) + - [インポート](ADMIN_ITEM_01.md#インポート) + - [RO-Crateインポート](ADMIN_ITEM_01.md#ro-crateインポート) + - [インデックスツリー管理](ADMIN_INDEXTREE_01.md#インデックスツリー管理) + - [ツリー編集](ADMIN_INDEXTREE_01.md#ツリー編集) + - [雑誌情報](ADMIN_INDEXTREE_01.md#雑誌情報) + - [カスタムソート](ADMIN_INDEXTREE_01.md#カスタムソート) + - [ウェブデザイン管理](ADMIN_WEB_DESIGN_01.md#ウェブデザイン管理) + - [ウィジェット](ADMIN_WEB_DESIGN_01.md#ウィジェット) + - [ページレイアウト](ADMIN_WEB_DESIGN_01.md#ページレイアウト) + - [著者DB管理](ADMIN_AUTHOR_01.md#著者-db-管理) + - [編集](ADMIN_AUTHOR_01.md#編集) + - [一括出力](ADMIN_AUTHOR_01.md#一括出力) + - [一括登録](ADMIN_AUTHOR_01.md#一括登録) + - [統計](ADMIN_STATISTICS_01.md#統計) + - [運用レポート](ADMIN_STATISTICS_01.md#運用レポート) + - [フィードバックメール](ADMIN_STATISTICS_01.md#フィードバックメール) + - [サイトライセンス](ADMIN_STATISTICS_01.md#サイトライセンス) + - [ワークフロー管理](ADMIN_WORKFLOW_01.md#ワークフロー管理) + - [フロー](ADMIN_WORKFLOW_01.md#フロー) + - [フロー一覧](ADMIN_WORKFLOW_01.md#フロー一覧) + - [フロー作成](ADMIN_WORKFLOW_01.md#フロー作成) + - [フロー編集](ADMIN_WORKFLOW_01.md#フロー編集) + - [ワークフロー](ADMIN_WORKFLOW_01.md#ワークフロー) + - [ワークフロー一覧](ADMIN_WORKFLOW_01.md#ワークフロー一覧) + - [ワークフロー作成](ADMIN_WORKFLOW_01.md#ワークフロー作成) + - [ワークフロー編集](ADMIN_WORKFLOW_01.md#ワークフロー編集) + - [ワークスペース設定](ADMIN_WORKFLOW_01.md#ワークスペース設定) + - [コミュニティ管理](ADMIN_COMMUNITY_01.md#コミュニティ管理) + - [コミュニティ](ADMIN_COMMUNITY_01.md#コミュニティ) + - [参加リクエスト](ADMIN_COMMUNITY_01.md#参加リクエスト) + - [注目のコミュニティ](ADMIN_COMMUNITY_01.md#注目のコミュニティ) + - [OAI-PMH](ADMIN_OAI_PMH_01.md#oai-pmh) + - [ハーベスト](ADMIN_OAI_PMH_01.md#ハーベスト) + - [Identify](ADMIN_OAI_PMH_01.md#identify) + - [set](ADMIN_OAI_PMH_01.md#set) + - [Resource Sync](ADMIN_RESOURCE_SYNC_01.md#resource-sync) + - [Resource List](ADMIN_RESOURCE_SYNC_01.md#resource-list) + - [Change List](ADMIN_RESOURCE_SYNC_01.md#change-list) + - [Resync](ADMIN_RESOURCE_SYNC_01.md#resync) + - [SWORD API](ADMIN_SWORD_API_01.md#sword-api) + - [TSV/XML](ADMIN_SWORD_API_01.md#tsvxml) + - [JSON-LD](ADMIN_SWORD_API_01.md#json-ld) + - [ファイル管理](ADMIN_FILES_01.md#ファイル管理) + - [バケット](ADMIN_FILES_01.md#バケット) + - [ファイルインスタンス](ADMIN_FILES_01.md#ファイルインスタンス) + - [ロケーション](ADMIN_FILES_01.md#ロケーション) + - [マルチパートオブジェクト](ADMIN_FILES_01.md#マルチパートオブジェクト) + - [オブジェクトバージョン](ADMIN_FILES_01.md#オブジェクトバージョン) + - [レコード管理](ADMIN_RECORDS_01.md#レコード管理) + - [永続識別子](ADMIN_RECORDS_01.md#永続識別子) + - [レコードメタデータ](ADMIN_RECORDS_01.md#レコードメタデータ) + - [ユーザー管理](ADMIN_USER_01.md#ユーザー管理) + - [アクセス：ロール](ADMIN_USER_01.md#アクセスロール) + - [アクセス：システム](ADMIN_USER_01.md#アクセスシステム) + - [アクセス：ユーザー](ADMIN_USER_01.md#アクセスユーザー) + - [連結アカウント識別子](ADMIN_USER_01.md#連結アカウント識別子) + - [連結アカウントトークン](ADMIN_USER_01.md#連結アカウントトークン) + - [連結アカウント](ADMIN_USER_01.md#連結アカウント) + - [OAuthアプリケーショントークン](ADMIN_USER_01.md#oauthアプリケーショントークン) + - [OAuthアプリケーション](ADMIN_USER_01.md#oauthアプリケーション) + - [ロール](ADMIN_USER_01.md#ロール) + - [セッションアクティビティ](ADMIN_USER_01.md#セッションアクティビティ) + - [ユーザー](ADMIN_USER_01.md#ユーザー) + - [ユーザープロファイル](ADMIN_USER_01.md#ユーザープロファイル) + - [設定](ADMIN_SETTING_01.md#設定) + - [アイテム表示](ADMIN_SETTING_01.md#アイテム表示) + - [アクティビティ一覧表示](ADMIN_SETTING_01.md#アクティビティ一覧表示) + - [インデックスリンク表示](ADMIN_SETTING_01.md#インデックスリンク表示) + - [言語表示](ADMIN_SETTING_01.md#言語表示) + - [PDFカバーページ表示](ADMIN_SETTING_01.md#pdfカバーページ表示) + - [ランキング表示](ADMIN_SETTING_01.md#ランキング表示) + - [統計情報表示](ADMIN_SETTING_01.md#統計情報表示) + - [画面背景色](ADMIN_SETTING_01.md#画面背景色) + - [識別子](ADMIN_SETTING_01.md#識別子) + - [アイテム一括出力](ADMIN_SETTING_01.md#アイテム一括出力) + - [ログ解析](ADMIN_SETTING_01.md#ログ解析) + - [検索設定](ADMIN_SETTING_01.md#検索設定) + - [ファセット検索](ADMIN_SETTING_01.md#ファセット検索) + - [サイト情報](ADMIN_SETTING_01.md#サイト情報) + - [サイトライセンス](ADMIN_SETTING_01.md#サイトライセンス) + - [サイトマップ](ADMIN_SETTING_01.md#サイトマップ) + - [メール送信](ADMIN_SETTING_01.md#メール送信) + - [WebAPIアカウント](ADMIN_SETTING_01.md#webapiアカウント) + - [ファイルプレビュー](ADMIN_SETTING_01.md#ファイルプレビュー) + - [Shibboleth](ADMIN_SETTING_01.md#shibboleth) + - [制限公開](ADMIN_SETTING_01.md#制限公開) + - [CRIS連携](ADMIN_SETTING_01.md#cris連携) + - [その他](ADMIN_SETTING_01.md#その他) + - [ログ管理](ADMIN_LOGS_01.md#ログ管理) + - [エクスポート](ADMIN_LOGS_01.md#エクスポート) + - [メンテナンス](ADMIN_MAINTENANCE_01.md#メンテナンス) + - [ElasticSearchインデックス](ADMIN_MAINTENANCE_01.md#elasticsearchインデックス) + - [アドバンスド](ADMIN_ADVANCED_ADMIN_01.md#アドバンスド) + - [プロフィール編集画面](ADMIN_ADVANCED_ADMIN_01.md#プロフィール編集画面) +- API + - [アイテム](API_ITEM_01.md#アイテム) + - [GET /api/\/records](API_ITEM_01.md#get-apiversionrecords) + - [GET /api/records/](API_ITEM_01.md#get-apirecords) + - [GET /api/\/records/\](API_ITEM_01.md#get-apiversionrecordspid_value) + - [GET /api/\/records/\/stats](API_ITEM_01.md#get-apiversionrecordspid_valuestats) + - [POST /api/\/records/list](API_ITEM_01.md#post-apiversionrecordslist) + - [GET /api/index/](API_ITEM_01.md#get-apiindex) + - [PUT /api/records/](API_ITEM_01.md#put-apirecords) + - [ファイル](API_FILE_01.md#ファイル) + - [GET /api/\/ranking//files](API_FILE_01.md#get-apiversionrankingpid_valuefiles) + - [GET /api/\/records//files/\](API_FILE_01.md#get-apiversionrecordspid_valuefilesfilename) + - [GET /api/\/records//files/\/stats](API_FILE_01.md#get-apiversionrecordspid_valuefilesfilenamestats) + - [GET /api/\/records//files/all](API_FILE_01.md#get-apiversionrecordspid_valuefilesall) + - [POST /api/\/records//files/selected](API_FILE_01.md#post-apiversionrecordspid_valuefilesselected) + - [GET /api/\/ranking/](API_FILE_01.md#get-apiversionrankingranking_type) + - [インデックス](API_INDEX_01.md#インデックス) + - [GET /api/\/tree](API_INDEX_01.md#get-apiversiontree) + - [GET /api/\/tree/](API_INDEX_01.md#get-apiversiontreeindex_id) + - [GET /api/\/tree/index](API_INDEX_01.md#get-apiversiontreeindex) + - [GET /api/\/tree/index/\](API_INDEX_01.md#get-apiversiontreeindexindex_id) + - [GET /api/\/tree/index/\/parent](API_INDEX_01.md#get-apiversiontreeindexindex_idparent) + - [POST /api/\/tree/index](API_INDEX_01.md#post-apiversiontreeindex) + - [PUT /api/\/tree/index/](API_INDEX_01.md#put-apiversiontreeindexindex_id) + - [DELETE /api/\/tree/index/](API_INDEX_01.md#delete-apiversiontreeindexindex_id) + - [アクティビティ](API_ACTIVITY_01.md#アクティビティ) + - [POST /api/depositactivity](API_ACTIVITY_01.md#post-apidepositactivity) + - [GET /api/depositactivity/\](API_ACTIVITY_01.md#get-apidepositactivityactivity_id) + - [DELETE /api/depositactivity/\](API_ACTIVITY_01.md#delete-apidepositactivityactivity_id) + - [OpenSearch](API_OPEN_SEARCH_01.md#opensearch) + - [GET /api/opensearch/description.xml](API_OPEN_SEARCH_01.md#get-apiopensearchdescriptionxml) + - [GET /api/opensearch/search](API_OPEN_SEARCH_01.md#get-apiopensearchsearch) + - [著者](API_AUTHOR_01.md#著者) + - [GET /api/\/authors](API_AUTHOR_01.md#get-apiversionauthors) + - [POST /api/\/authors](API_AUTHOR_01.md#post-apiversionauthors) + - [PUT /api/\/authors/\](API_AUTHOR_01.md#put-apiversionauthorsidentifier) + - [DELETE /api/\/authors/\](API_AUTHOR_01.md#delete-apiversionauthorsidentifier) + - [GET /api/\/authors/count](API_AUTHOR_01.md#get-apiversionauthorscount) + - [リクエストメール](API_REQUEST_MAIL_01.md#リクエストメール) + - [GET /api/\/authors](API_REQUEST_MAIL_01.md#get-apiversionauthors) + - [POST /api/\/authors](API_REQUEST_MAIL_01.md#post-apiversionauthors) + - [PUT /api/\/authors/\](API_REQUEST_MAIL_01.md#put-apiversionauthorsidentifier) + - [DELETE /api/\/authors/\](API_REQUEST_MAIL_01.md#delete-apiversionauthorsidentifier) + - [GET /api/\/authors/count](API_REQUEST_MAIL_01.md#get-apiversionauthorscount) + - [ログイン](API_LOGIN_01.md#ログイン) + - [POST /api/\/login](API_LOGIN_01.md#post-apiversionlogin) + - [POST /api/\/logout](API_LOGIN_01.md#post-apiversionlogout) + - [OAステータス](API_OA_STATUS_01.md#oa-ステータス) + - [POST /api/\/oa_status/callback](API_OA_STATUS_01.md#post-apiversionoa_statuscallback) + - [SWORD API](API_SWORD_API_01.md#SWORD-API) + - [GET /sword/service-document](API_SWORD_API_01.md#get-swordservice-document) + - [GET /sword/deposit/\](API_SWORD_API_01.md#get-sworddepositrecid) + - [POST /sword/service-document](API_SWORD_API_01.md#post-swordservice-document) + - [PUT /sword/deposit/\](API_SWORD_API_01.md#put-sworddepositrecid) + - [DELETE /sword/deposit/](API_SWORD_API_01.md#delete-sworddeposit) + - [制限公開](API_RESTRICTED_ACCESS_01.md#制限公開) + - [GET /api/\/workflow/activities](API_RESTRICTED_ACCESS_01.md#get-apiversionworkflowactivities) + - [POST /api/\/workflow/activities/\/approve](API_RESTRICTED_ACCESS_01.md#post-apiversionworkflowactivitiesactivity_idapprove) + - [POST /api/\/workflow/activities/\/throw-out](API_RESTRICTED_ACCESS_01.md#post-apiversionworkflowactivitiesactivity_idthrow-out) + - [GET /api/\/records/\/files/\/terms](API_RESTRICTED_ACCESS_01.md#get-apiversionrecordspidfilesfilenameterms) + - [POST /api/\/records/\/files/\/application](API_RESTRICTED_ACCESS_01.md#post-apiversionrecordspidfilesfilenameapplication) + - [POST /api/\/workflow/activities/\/application](API_RESTRICTED_ACCESS_01.md#post-apiversionworkflowactivitiesactivity_idapplication) + - [GET /api/\/records/\/need-restricted-access](API_RESTRICTED_ACCESS_01.md#get-apiversionrecordspidneed-restricted-access) diff --git a/docs/spec/base/access_control/USER_ACCOUNT_SETTING_01.md b/docs/spec/base/access_control/USER_ACCOUNT_SETTING_01.md new file mode 100644 index 00000000..257a55e0 --- /dev/null +++ b/docs/spec/base/access_control/USER_ACCOUNT_SETTING_01.md @@ -0,0 +1,116 @@ +# アカウント設定画面 + +アカウント設定画面のアクセスコントロールについて記述します。 + +## 目次 + +- [プロフィール](#プロフィール) +- [Security](#security) +- [通知](#通知) +- [アプリケーション](#アプリケーション) +- [Groups](#groups) +- [セッション](#セッション) +- [Administration](#administration) +- [Workspace](#workspace) + +## プロフィール + +エンドポイント：/account/settings/profile/ + +○ に合致すれば、プロフィール画面の閲覧が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +## Security + +エンドポイント：/account/settings/security/ + +○ に合致すれば、セキュリティ画面の閲覧が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +## 通知 + +エンドポイント：/account/settings/notifications/ + +#### ページの閲覧および Web プッシュ通知の有効化 + +○ に合致すれば、通知画面の閲覧、Web プッシュ通知機能の切り替えが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +#### メール通知の有効化 + +○ に合致すれば、通知画面の閲覧、メール通知機能の切り替えが出来ます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ユーザーのメールアドレスが
確認済みである | ○ | ○ | ○ | ○ | ○ | × | +| ユーザーのメールアドレスが
確認済みでない | × | × | × | × | × | × | + +## アプリケーション + +エンドポイント：/account/settings/applications/ + +○ に合致すれば、アプリケーション画面の閲覧、アプリケーションやトークンの発行が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +## Groups + +エンドポイント：/accounts/settings/groups/ + +#### グループ画面の閲覧 + +○ に合致すれば、グループ画面の閲覧が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +#### グループの作成、編集、削除 + +○ に合致すれば、グループの作成や、作成したグループの編集、削除を行うことが出来ます。 +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## セッション + +エンドポイント：/accounts/settings/session/ + +○ に合致すれば、セッション画面の閲覧、設定値の変更が出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## Administration + +エンドポイント：/admin/ + +○ に合致すれば、管理画面を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | × | × | × | + +## Workspace + +エンドポイント：/workspace/ + +ワークスペースについては[ワークスペース](USER_WORKSPACE_01.md#ワークスペース)を参照ください。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_COMMUNITY_SUBREPOSITORY_01.md b/docs/spec/base/access_control/USER_COMMUNITY_SUBREPOSITORY_01.md new file mode 100644 index 00000000..5fe47bcf --- /dev/null +++ b/docs/spec/base/access_control/USER_COMMUNITY_SUBREPOSITORY_01.md @@ -0,0 +1,51 @@ +# コミュニティ + +コミュニティ(サブリポジトリ)のアクセスコントロールについて記述します。 + +## 目次 + +- [コミュニティ一覧](#コミュニティ一覧) +- [コミュニティ画面](#コミュニティ画面) +- [コンテンツポリシー](#コンテンツポリシー) + +## コミュニティ一覧 + +エンドポイント：/c/list/ + +全てのロールでコミュニティ一覧を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +全てのロールでコミュニティが一覧に表示されます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## コミュニティ画面 + +エンドポイント：/c/<コミュニティID> + +全てのロールでコミュニティ画面を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## コンテンツポリシー + +エンドポイント：/c/<コミュニティID>/content_policy/ + +全てのロールでコンテンツポリシーを閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_FILES_DETAIL_01.md b/docs/spec/base/access_control/USER_FILES_DETAIL_01.md new file mode 100644 index 00000000..ad6c6dd9 --- /dev/null +++ b/docs/spec/base/access_control/USER_FILES_DETAIL_01.md @@ -0,0 +1,215 @@ +# ファイル + +アイテムの添付ファイルのアクセスコントロールについて記述します。 + +エンドポイント: /records/<アイテムID>/file_details + +## 目次 + +- [ファイルダウンロード](#ファイルダウンロード) +- [ファイル情報](#ファイル情報) +- [ファイルプレビュー](#ファイルプレビュー) +- [ファイル置き換え](#ファイル置き換え) +- [公開バケットへのコピー](#公開バケットへのコピー) +- [シークレットURL](#シークレットurl) + - [シークレットURL設定編集機能](#シークレットurl設定編集機能) + - [作成済みシークレットURL編集機能](#作成済みシークレットurl編集機能) + - [利用申請](#利用申請) + +## ファイルダウンロード + +表内のいずれかの条件の○に合致すればダウンロードが可能です。 + +#### ファイル公開設定：オープンアクセス + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### ファイル公開設定：オープンアクセス日を指定する（指定日前） + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × ※1 | × ※1 | × ※2 | + +※1 ダウンロードボタンを押下するとエラー画面へ遷移します。
+※2 ダウンロードボタンを押下するとログイン画面へ遷移します。 + +#### ファイル公開設定：ログインユーザーのみ + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | × ※1 | + +※1 ダウンロードボタンを押下するとログイン画面へ遷移します。 + +#### ファイル公開設定：公開しない + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +## ファイル情報 + +表内のいずれかの条件の○に合致すれば情報閲覧が可能です。 + +#### ファイル公開設定：公開しない「以外」 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### ファイル公開設定：公開しない + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +## ファイルプレビュー + +「ファイル情報 > 表示形式」が「プレビュー」の場合、ファイルプレビューを行うことが出来ます。 + +表内のいずれかの条件の○に合致すればプレビュー閲覧が可能です。 + +#### ファイル公開設定：オープンアクセス + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### ファイル公開設定：オープンアクセス日を指定する（指定日前） + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × ※1 | × ※1 | × ※2 | + +※1 プレビューボタンを押下するとエラーアラートが表示されます。
+※2 プレビューボタンを押下するとログイン画面へ遷移します。 + +#### ファイル公開設定：ログインユーザーのみ + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | × ※1 | + +※1 プレビューボタンを押下するとログイン画面へ遷移します。 + +#### ファイル公開設定：公開しない + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +## ファイル置き換え + +表内のいずれかの条件の○に合致すればファイルの置き換えが可能です。 + +ファイルの公開設定によるアクセスコントロールの差異はありません。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 公開バケットへのコピー + +表内のいずれかの条件の○に合致すれば公開バケットへのコピーが可能です。 + +ファイルの公開設定によるアクセスコントロールの差異はありません。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## シークレットURL + +表内のいずれかの条件の○に合致すればシークレットURLの操作が可能です。 + +### シークレットURL設定編集機能 + +ファイルの公開設定によるアクセスコントロールの差異はありません。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +### 作成済みシークレットURL編集機能 + +ファイルの公開設定によるアクセスコントロールの差異はありません。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +### 利用申請 + +対象のファイルのアクセスロールが「制限公開」であり、ユーザーにダウンロード権限がない場合に[申請]ボタンが表示されます。 + +画面を表示しているユーザー（ゲストを含む）のロールがアイテムに設定されている利用申請とロールのペアに含まれていれば申請権限が与えられます。 + +上記の申請権限があり、また表内のいずれかの条件の○に合致すれば利用申請を行うことが可能です。 + +#### ファイル公開設定：オープンアクセス + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +#### ファイル公開設定：オープンアクセス日を指定する（指定日前） + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | ○ | ○ | ○ | + +#### ファイル公開設定：ログインユーザーのみ + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | ○ | ○ | + +#### ファイル公開設定：公開しない + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ---------------- | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_ITEM_DETAIL_01.md b/docs/spec/base/access_control/USER_ITEM_DETAIL_01.md new file mode 100644 index 00000000..c2e73604 --- /dev/null +++ b/docs/spec/base/access_control/USER_ITEM_DETAIL_01.md @@ -0,0 +1,693 @@ +# アイテム詳細画面 + +アイテム詳細画面のアクセスコントロールについて記述します。 + +エンドポイント: /records/<アイテムID> + +## 目次 + +- [アイテム閲覧](#アイテム閲覧) +- [アイテム編集](#アイテム編集) +- [アイテム削除](#アイテム削除) +- [バージョン削除](#バージョン削除) +- [公開ステータス変更](#公開ステータス変更) +- [リクエストメール](#リクエストメール) +- [利用申請](#利用申請) +- [エクスポート](#エクスポート) + - [OAI-PMH](#oai-pmh) + - [Other Formats](#other-formats) +- [コミュニティ](#コミュニティ) + +## アイテム閲覧 + +表内のいずれかの○に合致すればアイテムを閲覧することが出来ます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## アイテム編集 + +いずれかの○に合致すればアイテムを編集することが出来ます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## アイテム削除 + +いずれかの○に合致すればアイテムを削除出来ます。 + +ただし、以下の場合は削除出来ません。 + +1. `DOI`が付与されているアイテムは削除出来ません。
+2. `DOI`が付与されているアイテムに対して、アイテムが直接紐づいているインデックスとその上位のインデックスのうち1つでも非表示設定がある場合も削除出来ません。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## バージョン削除 + +アイテムに「バージョン」が複数あり、かつユーザーに削除権限がある場合に本機能の利用が可能です。 + +いずれかの○に合致すればアイテムのバージョンを削除出来ます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 公開ステータス変更 + +いずれかの○に合致すればアイテムの公開ステータスを変更出来ます。 + +※ `DOI`が付与されているアイテムはステータスを非公開に変更することは出来ません。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## リクエストメール + +アイテム登録時、および編集時にリクエストメールの送信先が設定されていれば、本機能の利用が可能です。 + +いずれかの○に合致すればリクエストメールを送信することが出来ます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 利用申請 + +パスワードチェック機能が`ON`で、ユーザーがログインしていない場合のみ[申請]ボタンが表示されます。 + +※ 公開日を迎えていないアイテムで利用申請を行うことは出来ません。 + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | ○ | + +#### 公開日以降 / Publish Status： 非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +#### 公開日以降 / Publish Status： 非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | × | × | × | × | × | × | +| 代理投稿者：自分 | × | × | × | × | × | × | +| 上記以外 | × | × | × | × | × | × | + +## エクスポート + +いずれかの○に合致すればそれぞれの形式でエクスポートすることが出来ます。 + +### OAI-PMH + +エンドポイント: `/oai` + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +### Other Formats + +エンドポイント: `/records/<アイテムID>/export/<フォーマット>` + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## コミュニティ + +アイテムが所属するコミュニティがある場合、コミュニティの「アイコン」と「タイトル」が表示されます。
+所属するコミュニティがない場合は、コミュニティエリアは空の状態で表示されます。 + +いずれかの○に合致すればコミュニティボタンを利用することが出来ます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_ITEM_EXPORT_01.md b/docs/spec/base/access_control/USER_ITEM_EXPORT_01.md new file mode 100644 index 00000000..cfa7e419 --- /dev/null +++ b/docs/spec/base/access_control/USER_ITEM_EXPORT_01.md @@ -0,0 +1,52 @@ +# アイテムエクスポート + +アイテムエクスポートのアクセスコントロールについて記述します。 + +エンドポイント：/items/export + +## 目次 + +- [アイテムエクスポート](#アイテムエクスポート) +- [アイテムエクスポート機能](#アイテムエクスポート機能) +- [アイテムエクスポート機能（ファイルコンテンツ有）](#アイテムエクスポート機能ファイルコンテンツ有) + +## アイテムエクスポート + +アイテムエクスポートページは全ロールで閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## アイテムエクスポート機能 + +表示されているアイテムは全ロールでエクスポートすることが出来ます。 + +アイテムの表示条件は検索画面で検索結果にアイテムが表示されるかどうかと同一条件です。
+[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | ○ | + +## アイテムエクスポート機能（ファイルコンテンツ有） + +対象のアイテムのファイルダウンロード機能を利用出来るユーザーは、「Export File Contents」にチェックを付けて実行するとファイルコンテンツ付きでアイテムをエクスポート出来ます。
+ファイルダウンロード機能の利用可否は[ファイルダウンロード](USER_FILES_DETAIL_01.md##ファイルダウンロード)を参照ください。 + +アイテムの表示条件は検索画面で検索結果にアイテムが表示されるかどうかと同一条件です。
+[検索画面](USER_ITEM_SEARCH_01.md#検索画面)を参照ください。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ファイルダウンロード
機能利用可 | ○ | ○ | ○ | ○ | ○ | ○ | +| ファイルダウンロード
機能利用不可 | ○ | ○ | × ※3 | × ※3 | × ※3 | × ※3 | + +※3 Messageに「Contains restricted content」と表示され、エクスポートを実行してもファイルコンテンツはエクスポートされません。
+　（アイテムのみエクスポートされます。） + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_ITEM_RANKING_01.md b/docs/spec/base/access_control/USER_ITEM_RANKING_01.md new file mode 100644 index 00000000..c4a442f2 --- /dev/null +++ b/docs/spec/base/access_control/USER_ITEM_RANKING_01.md @@ -0,0 +1,85 @@ +# ランキング + +ランキングのアクセスコントロールについて記述します。 + +## 目次 + +- [ランキング](#ランキング) +- [ランキング表示](#ランキング表示) + +## ランキング + +エンドポイント：/items/ranking + +管理画面の 設定 ＞ ランキング表示 の「ランキング表示」の設定値がONであればランキングタブが表示され、ランキングページを閲覧することが出来ます。 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 「ランキング表示」の
設定値：ON | ○ | ○ | ○ | ○ | ○ | ○ | +| 「ランキング表示」の
設定値：OFF | × | × | × | × | × | × | + +## ランキング表示 + +表内のいずれかの○に合致すれば、「最も閲覧されたアイテム」、「最もダウンロードされたアイテム」のアイテムがランキングページに表示されます。 + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | ○ | ○ | ○ | + +#### 公開日以前 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：有 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以前 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +#### 公開日以降 / Publish Status：非公開 / アイテム登録済みインデックスの閲覧権限：無 + +| 条件 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記以外 | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/access_control/USER_ITEM_SEARCH_01.md b/docs/spec/base/access_control/USER_ITEM_SEARCH_01.md new file mode 100644 index 00000000..faffd3b5 --- /dev/null +++ b/docs/spec/base/access_control/USER_ITEM_SEARCH_01.md @@ -0,0 +1,175 @@ +# 検索画面 + +検索画面のアクセスコントロールについて記述します。 + +エンドポイント：（/search） + +## 目次 + +- [簡易検索](#簡易検索) +- [詳細検索](#詳細検索) +- [ファセット検索](#ファセット検索) +- [インデックス閲覧権限](#インデックス閲覧権限) + +## 簡易検索 + +検索結果に表示されるかどうかは、インデックスの閲覧権限、およびアイテムの公開日と公開ステータスの条件によって決まります。 + +#### ① インデックス閲覧権限がある場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | ○ | ○ | ○ | ○ | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +#### ② インデックス閲覧権限がない場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +※1 厳密には管理画面のユーザー管理 > アクセス: ロールでsearch-accessのActionが与えられたロールを指します。 + +※2 厳密には管理画面のユーザー管理 > アクセス: ロールでsearch-accessのActionが与えられていないロールを指します。 + +※ インデックス閲覧権限については [インデックス閲覧権限](#インデックス閲覧権限)の項目を参照してください。 + +## 詳細検索 + +検索結果に表示されるかどうかは、インデックスの閲覧権限、およびアイテムの公開日と公開ステータスの条件によって決まります。 + +#### ① インデックス閲覧権限がある場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | ○ | ○ | ○ | ○ | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +#### ② インデックス閲覧権限がない場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +※1 厳密には管理画面のユーザー管理 > アクセス: ロールでsearch-accessのActionが与えられたロールを指します。 + +※2 厳密には管理画面のユーザー管理 > アクセス: ロールでsearch-accessのActionが与えられていないロールを指します。 + +※ インデックス閲覧権限については [インデックス閲覧権限](#インデックス閲覧権限)の項目を参照してください。 + +## ファセット検索 + +検索結果に表示されるかどうかは、インデックスの閲覧権限、およびアイテムの公開日と公開ステータスの条件によって決まります。 + +#### ① インデックス閲覧権限がある場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | ○ | ○ | ○ | ○ | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +#### ② インデックス閲覧権限がない場合 + +以下の条件1,2のどちらかが○なら検索結果に表示され、両方×なら表示されません。 + +| 条件1 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開日以降かつ
公開ステータス：Publish | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +| 条件2 /ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者※1 | 登録ユーザー※1 | 一般ユーザー※2 | ゲスト
（未ログイン） | +| -------------------------------- | ------------------ | -------------------- | ------------------------ | -------------- | -------------- | ------------------------ | +| 作成者または
代理投稿者が自身 | ○ | ○ | × | × | × | × | +| 上記を満たさない | ○ | ○ | × | × | × | × | + +※1 厳密には管理画面のユーザー管理 > アクセス：ロールでsearch-accessのActionが与えられたロールを指します。 + +※2 厳密には管理画面のユーザー管理 > アクセス：ロールでsearch-accessのActionが与えられていないロールを指します。 + +※ インデックス閲覧権限については [インデックス閲覧権限](#インデックス閲覧権限)の項目を参照してください。 + +## インデックス閲覧権限 + +インデックスの閲覧権限を得るには、条件1～4のすべてを満たす必要があります。 + +一つでも×があれば閲覧不可、すべて○であれば閲覧が可能です。 + +条件1 インデックス公開ステータス + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開 | ○ | ○ | ○ | ○ | ○ | ○ | +| 非公開 | ○ | ○ | ○ ※1 | × | × | × | + +※1 自身が管理するインデックスに限ります。 + +条件2 公開日前/後 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 公開前 | ○ | ○ | ○ ※1 | × | × | × | +| 公開後、または
公開日：指定なし | ○ | ○ | ○ | ○ | ○ | ○ | + +※1 自身が管理するインデックスに限ります。 + +条件3 親インデックス閲覧可否 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 可 | ○ | ○ | ○ | ○ | ○ | ○ | +| 不可 | ○ | ○ | × | × | × | × | + +条件4 ユーザーの持つロールの1個以上が「権限あり」に設定されている、かつユーザーの持つグループの1個以上が「権限あり」に設定されている ※1 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 設定されて
いる | ○ | ○ | ○ | ○ | ○ | ○ | +| 設定されて
いない | ○ | ○ | ○ ※2 | × | × | × | + +※1 「権限あり」とは、管理画面のインデックスツリー管理 ＞ ツリー編集 でインデックスごとに設定出来る「閲覧権限」の値です。 + +※2 自身が管理するインデックスに限ります。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | +| 2025/11/14|213e1edb08782bee732b86d55c34240bc9758867|インデックス権限判定の修正| diff --git a/docs/spec/base/access_control/USER_WORKFLOW_ACTIVITY_01.md b/docs/spec/base/access_control/USER_WORKFLOW_ACTIVITY_01.md new file mode 100644 index 00000000..6a62ee5e --- /dev/null +++ b/docs/spec/base/access_control/USER_WORKFLOW_ACTIVITY_01.md @@ -0,0 +1,362 @@ +# ワークフローアクティビティ + +ワークフローアクティビティのアクセスコントロールについて記述します。 + +## 目次 + +- [ワークフロー](#ワークフロー) + - [ToDoタブ](#todoタブ) + - [Waitタブ](#waitタブ) + - [Allタブ](#allタブ) +- [アクティビティ](#アクティビティ) + - [新規アクティビティ](#新規アクティビティ) + - [ItemRegistration](#itemregistration) + - [ItemLink](#itemlink) + - [IdentifierGrant](#identifiergrant) + - [Approval](#approval) +- [インデックス投稿権限](#インデックス投稿権限) + +## ワークフロー + +いずれかの○に合致すればワークフローページの閲覧が出来ます。 + +エンドポイント：　/workflow/ + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ページ閲覧可否 | ○ | ○ | ○ | ○ | × | × | + +### アクティビティタブ + +タブはToDoタブ、Waitタブ、All（全て）タブの3種類です。 + +いずれかの○に合致すればタブにアクティビティが表示されます。 + +また、表示内容はユーザーのロールとアクティビティの状態（作成中・編集中・承認待ちなど）によって動的に変化します。 + +#### ToDoタブ + +エンドポイント：/workflow/?tab=todo + +**アクティビティの状態：新規アイテム作成中 / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：新規アイテム作成中 / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：既存アイテム編集中 / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：既存アイテム編集中 / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +#### Waitタブ + +エンドポイント：/workflow/?tab=wait + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +#### Allタブ + +エンドポイント：/workflow/?tab=all + +**アクティビティの状態：新規アイテム作成中 / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | ○ | × | × | × | + +**アクティビティの状態：新規アイテム作成中 / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：既存アイテム編集中 / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | ○ | × | × | × | + +**アクティビティの状態：既存アイテム編集中 / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | ○ | × | × | × | + +**アクティビティの状態：承認待ち / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外 | ○ | ○ | × | × | × | × | + +**アクティビティの状態：承認済み・強制終了 / 投稿先インデックスが所属コミュニティに登録：あり** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外
代理投稿者：自分 | ○ | ○ | ○ | ○ | × | × | +| アクティビティ操作者：
自分以外
代理投稿者：自分以外 | ○ | ○ | ○ | × | × | × | + +**アクティビティの状態：承認済み・強制終了 / 投稿先インデックスが所属コミュニティに登録：なし** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アクティビティ操作者：
自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外
代理投稿者：自分 | ○ | ○ | × | ○ | × | × | +| アクティビティ操作者：
自分以外
代理投稿者：自分以外 | ○ | ○ | × | × | × | × | + +### アクティビティ + +エンドポイント：/workflow/activity + +アクティビティの閲覧はユーザーのロールとアクセス元によって変化します。 + +いずれかの○に合致すればアクティビティを操作出来ます。 + +
+ +**アクセス元：ToDoタブ** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ページ閲覧可否 | ○ | ○ | ○ | ○ | × | × | + +**アクセス元：アイテム詳細画面 > [編集]ボタン** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +#### 新規アクティビティ + +エンドポイント：/workflow/activity/new + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ページの閲覧可否 | ○ | ○ | ○ | ○ | ○※1 | × | + +※1 URL入力で直接アクセスすることで閲覧可能 + +**管理画面 ワークフロー管理 ＞ ワークフローの表示/非表示欄でユーザーの持つロールが「表示」に登録されている** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフロー表示 | ○ | ○ | ○ | ○ | ○ | × | + +**管理画面 ワークフロー管理 ＞ ワークフローの表示/非表示欄でユーザーの持つロールが「表示」に登録されていない** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ワークフロー表示 | × | × | × | × | × | × | + +#### ItemRegistration + +エンドポイント：/workflow/activity/detail/ + +**新規作成** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ページ閲覧可否 | ○ | ○ | ○ | ○ | × | × | + +**編集** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +**メタデータ入力** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**ファイルアップロード** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**代理投稿者指定** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**フィードバックメール指定** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**CRIS機関への自動連携** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**リクエストメール表示機能** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**バージョン変更** + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +**投稿インデックス指定機能** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| インデックス投稿権限：
あり | ○ | ○ | ○ | ○ | ○ | × | +| インデックス投稿権限：
なし | ○ | ○ | × | × | × | × | + +※ インデックス投稿権限については [インデックス投稿権限](#インデックス投稿権限)を参照してください。 + +#### ItemLink + +エンドポイント：/workflow/activity/detail/ + +いずれかの○に合致すれば、アイテムリンクのインデックスに選択肢が出てきます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| インデックス
閲覧権限：
あり | ○ | ○ | ○ | ○ | ○ | × | +| インデックス
閲覧権限：
なし | ○ | ○ | × | × | × | × | + +※ インデックス選択後にアイテムがアイテムリンク先の選択肢として出るかどうかは、検索画面でアイテムが検索結果に表示されるかどうかと同条件です。（ただし、アイテム自身は表示されません） +
詳しくは[検索画面](USER_ITEM_SEARCH_01.md)を参照ください。 + +※ 自身（操作中のアイテム）へのアイテムリンクは作成出来ません。 + +#### IdentifierGrant + +エンドポイント：/workflow/activity/detail/ + +いずれかの○に合致すれば、DOIの付与・取り下げを行うことが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +※ 一度DOIを取り下げしたアイテムは再度DOIを付与することは出来ません。 + +#### Approval + +エンドポイント：/workflow/activity/detail/ + +**アイテム承認可否** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | × | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | + +**ファイルプレビュー** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ○ | × | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +**制限公開フラグありの承認可否** + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 作成者：自分 | ○ | ○ | ○ | ×※1 | ×※1 | × | +| 代理投稿者：自分 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外 | ○ | ○ | ○ | × | × | × | + +※1 「トップページに戻る」のリンクが表示されます。 + +### インデックス投稿権限 + +インデックスへの投稿権限を得るには、以下2つの条件を満たす必要があります。 + +一つでも×があれば投稿不可、すべて○であれば投稿が可能です。 + +#### 条件1 親インデックスの投稿可否 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ----------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 可 | ○ | ○ | ○ | ○ | ○ | ○ | +| 不可 | ○ | ○ | ○ | × | × | × | + +#### 条件2 ユーザーの持つロールの1個以上が「権限あり」に設定されている、かつユーザーの持つグループの1個以上が「権限あり」に設定されている ※1 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 設定されている | ○ | ○ | ○ | ○ | ○ | ○ | +| 設定されていない | ○ | ○ | ○ | × | × | × | + +※1 「権限あり」とは、管理画面のインデックスツリー管理 ＞ ツリー編集 でインデックスごとに設定出来る「投稿権限」の値です。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | +| 2025/11/14|213e1edb08782bee732b86d55c34240bc9758867|インデックス権限判定の修正| diff --git a/docs/spec/base/access_control/USER_WORKSPACE_01.md b/docs/spec/base/access_control/USER_WORKSPACE_01.md new file mode 100644 index 00000000..5691419c --- /dev/null +++ b/docs/spec/base/access_control/USER_WORKSPACE_01.md @@ -0,0 +1,52 @@ +# ワークスペース + +ワークスペースのアクセスコントロールについて記述します。 + +## 目次 + +- [ワークスペース画面](#ワークスペース画面) +- [簡易アイテム登録画面](#簡易アイテム登録画面) + + +## ワークスペース画面 + +エンドポイント：/workspace/ + +○ に合致すれば、ワークスペース画面を閲覧することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +○ に合致するアイテムのみ、アイテム一覧、アイテム検索機能、アイテム出力機能で表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ------------------------------------------ | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| アイテムの作成者または
代理投稿者が自身 | ○ | ○ | ○ | ○ | ○ | × | +| 上記以外のアイテム | × | × | × | × | × | × | + +## 簡易アイテム登録画面 + +エンドポイント：/workspace/item_registration + +○ に合致すれば、簡易アイテム登録画面の閲覧、簡易アイテム登録機能およびメタデータ補完機能を使用することが出来ます。 + +| ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| -------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| 利用可否 | ○ | ○ | ○ | ○ | ○ | × | + +○ に合致するインデックスが、アイテム登録先の選択肢として表示されます。 + +| 条件/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
（未ログイン） | +| ---------------------------------- | ------------------ | -------------------- | ---------------------- | ------------ | ------------ | ------------------------ | +| ユーザーが閲覧可能なインデックス | ○ | ○ | ○ | ○ | × | × | +| ユーザーが閲覧不可のインデックス | ○ | ○ | × | × | × | × | + +※ インデックスの閲覧可否は画面からのアクセスと同一条件です。 +[インデックス閲覧権限](USER_ITEM_SEARCH_01.md#インデックス閲覧権限)を参照ください。 + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/admin/ADMIN_3_1.md b/docs/spec/base/admin/ADMIN_3_1.md index 4afc5163..1d3afab3 100644 --- a/docs/spec/base/admin/ADMIN_3_1.md +++ b/docs/spec/base/admin/ADMIN_3_1.md @@ -153,34 +153,38 @@ - Contributor - - Authenticated User + - Authenticated User : -98 - - Guest + - Guest : -99 - 「子インデックスのロール権限にも再帰的に反映させる」（Set the base authorities of child indexes recursively）チェックボックスにチェックを入れることで、所属するすべての子インデックスと子孫インデックスにロール権限の設定が再帰的に設定される。 - グループ権限の設定には、 「グループ権限あり」（Group Authorized）と「権限なし」（Unauthorized）エリアを設ける。 - - - 「グループ権限あり」（Group Authorized）は、デフォルトとして、登録されているグループが表示される。 + + - 「グループ権限あり」（Group Authorized）は、デフォルトとして、以下の権限が表示される。 + + - 登録されている全てのグループ + + - No Group : -89 - 「子インデックスのグループ権限にも再帰的に反映させる」（Set the base authorities of child indexes recursively）チェックボックスにチェックを入れることで、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定される。 - 学認mAP連携機能が有効な場合、閲覧権限の設定に学認mAPのグループ情報を利用できる。 - - グループIDのフォーマットが「jc\_\_roles\_」に従っている学認グループは、ロール権限として表示され閲覧権限を変更できる。 + - グループIDのフォーマットが「jc\_\_roles\_」に従っている学認グループは非表示となり、閲覧権限の判定時に無視される。 - には機関のFQDNから".","-"を"_"に置換した値が設定される。 - 例: abc-u.ac.jp → abc_u_ac_jp - - 例外的に「jc_roles_sysadm」もロール権限として表示され閲覧権限を変更できる。 + - 例外的に「jc_roles_sysadm」も非表示となり、閲覧権限の判定時に無視される。 - ロール権限に設定できるグループIDのフォーマット（プレフィックス、システム管理者用グループID）は、設定値 WEKO\_ACCOUNTS\_GAKUNIN\_GROUP\_PATTERN\_DICT を変更することで、フォーマットを変更できる。 - 上記以外のグループIDの場合はグループ権限として表示され、閲覧権限を変更できる。 - - ただし、学認mAPのグループ情報は内部的には全てロールとして扱われる。 + - 学認mAPのグループ情報は内部的にはロールだが、グループとして扱われる。 - 学認mAP連携機能でGakuNin mAPのグループ情報がWEKO3に追加された際、設定するmAPグループの閲覧権限のデフォルト値は、WEKO\_INDEXTREE\_GAKUNIN\_GROUP\_DEFAULT\_BROWSING\_PERMISSIONの真偽値から権限有無を決定する。 @@ -204,29 +208,33 @@ - Guest : -99 - 「子インデックスのロール権限にも再帰的に反映させる」（Set the base authorities of child indexes recursively）チェックボックスにチェックを入れることで、所属するすべての子インデックスと子孫インデックスにロール権限の設定が再帰的に設定される。 - + - グループ権限の設定には、 「グループ権限あり」（Group Authorized）と「権限なし」（Unauthorized）エリアを設ける。 - - 「グループ権限あり」（Group Authorized）は、デフォルトとして、登録されているグループが表示される。 + - 「グループ権限あり」（Group Authorized）は、デフォルトとして、以下の権限が表示される。 + + - 登録されている全てのグループ + + - No Group : -89 - 「子インデックスのグループ権限にも再帰的に反映させる」（Set the base authorities of child indexes recursively）チェックボックスにチェックを入れることで、所属する子インデックスと子孫インデックスすべてにグループの設定が再帰的に設定される。 - 学認mAP連携機能が有効な場合、投稿権限の設定に学認mAPのグループ情報を利用できる。 - - グループIDのフォーマットが「jc\_\_roles\_」に従っている学認グループは、ロール権限として表示され投稿権限を変更できる。 + - グループIDのフォーマットが「jc\_\_roles\_」に従っている学認グループは非表示となり、投稿権限の判定時に無視される。 - には機関のFQDNから".","-"を"_"に置換した値が設定される。 - 例: abc-u.ac.jp → abc_u_ac_jp - - 例外的に「jc_roles_sysadm」もロール権限として表示され投稿権限を変更できる。 + - 例外的に「jc_roles_sysadm」も非表示となり、投稿権限の判定時に無視される。 - ロール権限に設定できるグループIDのフォーマット（プレフィックス、システム管理者グループID）は、設定値 WEKO\_ACCOUNTS\_GAKUNIN\_GROUP\_PATTERN\_DICT を変更することで、フォーマットを変更できる。 - ロール権限として利用できない学認グループは、すべてグループ権限として表示され、投稿権限を変更できる。 - - ただし、学認mAPのグループ情報は内部的には全てロールとして扱われる。 + - 学認mAPのグループ情報は内部的にはロールだが、グループとして扱われる。 - 学認mAP連携機能でGakuNin mAPのグループ情報がWEKO3に追加された際、設定するmAPグループの投稿権限のデフォルト値は、WEKO\_INDEXTREE\_GAKUNIN\_GROUP\_DEFAULT\_CONTRIBUTE\_PERMISSIONの真偽値から権限有無を決定する。 @@ -379,11 +387,11 @@ |21| |biblio_flag|None| | |22|閲覧権限|browsing_role|3,-98,-99|ロールID| |23| |recursive_browsing_role|false| | -|24| |browsing_group|(現在存在するすべてのグループを許可)| | +|24| |browsing_group|(現在存在するすべてのグループを許可),-89| | |25| |recursive_browsing_group|false| | |26|投稿権限|contribute_role|1,2,3,4,-98,-99| | |27| |recursive_contribute_role|false| | -|28| |contribute_group|(現在存在するすべてのグループを許可)| | +|28| |contribute_group|(現在存在するすべてのグループを許可),-89| | |29| |recursive_contribute_group|false| | |30|表示形式|display_format|1(一覧形式を表す)|1:一覧形式, 2:目次形式| | |31|サムネイル|image_name|None|値に入るのはサムネイル画像のパスを表す文字列| @@ -413,5 +421,4 @@ | 2025/01/30|3530eae9075af6afc57b777d8c3137f038523610|学認mAP連携対応| | 2025/10/10|3581747ebfbda5f623e7b8da759293d2090c4112|インデックス公開ロック機能追加| | 2025/11/12|5254da1cf9caafb27a27f361ae36099da4f2c042|キャッシュ機能の改善| - - +| 2025/11/14|213e1edb08782bee732b86d55c34240bc9758867|インデックス権限判定の修正| diff --git a/docs/spec/base/admin/ADMIN_7_1.md b/docs/spec/base/admin/ADMIN_7_1.md index 8a152a30..64debf4a 100644 --- a/docs/spec/base/admin/ADMIN_7_1.md +++ b/docs/spec/base/admin/ADMIN_7_1.md @@ -84,7 +84,7 @@ - システム管理者、リポジトリ管理者は、システムに設定されたすべてのロールが表示される。 - サブリポジトリ管理者は、自身が管理するサブリポジトリに関連するロールのみが表示される。 - + - 「表示しない（Deny）」チェックボックスにチェックを入れる場合、選択されているロールが実施不可とする。 - 「Action User」カラムに、アクションを実行するユーザーを限定できる。 diff --git a/docs/spec/base/admin/ADMIN_7_2.md b/docs/spec/base/admin/ADMIN_7_2.md index e955cb87..9e4a7c38 100644 --- a/docs/spec/base/admin/ADMIN_7_2.md +++ b/docs/spec/base/admin/ADMIN_7_2.md @@ -190,4 +190,4 @@ |:---:|:---:|:---:| |> 2023/08/31|353ba1deb094af5056a58bb40f07596b8e95a562|初版作成| |> 2025/01/23|-|サブリポジトリ対応| -|> 2025/10/31|160a811eed2c61492558905db34fa0619da6b18f|要素の表示条件・アクセス権限を記載| \ No newline at end of file +|> 2025/10/31|160a811eed2c61492558905db34fa0619da6b18f|要素の表示条件・アクセス権限を記載| diff --git a/docs/spec/base/admin/ADMIN_8_1.md b/docs/spec/base/admin/ADMIN_8_1.md index d354fea5..01d90ee3 100644 --- a/docs/spec/base/admin/ADMIN_8_1.md +++ b/docs/spec/base/admin/ADMIN_8_1.md @@ -100,6 +100,7 @@ - 「Owner」プルダウン - 所有者のロールを選択する。必須項目である。デフォルトは1番目の項目とする - 「Owner」プルダウンの選択肢はシステムに登録されたロールの一覧である + - 表示形式は以下の通りである ロール - ロール説明(description) - 「Index」プルダウン diff --git a/docs/spec/base/ams/AMS_ACCESS_CONTROLL.md b/docs/spec/base/ams/AMS_ACCESS_CONTROLL.md new file mode 100644 index 00000000..3bc30289 --- /dev/null +++ b/docs/spec/base/ams/AMS_ACCESS_CONTROLL.md @@ -0,0 +1,468 @@ +# 未病フロント アクセスコントロール + +未病データベースにおけるアクセスコントロールについて記載します。 + +## 用語説明 + +本書では以下の用語で統一します。 + +| 用語 | 説明 | +| ------------------------ | ---------------------------------------- | +| 特定グループ
所属ユーザ | 特定のグループ(WEKO内部ではロール)に所属するログインユーザ
未病データベース内の全てのアイテムを閲覧可能となる想定 | +| オープンアクセス | 全てのユーザが閲覧可能であるアイテム | + +## 目次 + +- [TOP画面](#TOP画面) + - [アイテム最新情報取得](#アイテム最新情報取得) + - [アイテム検索](#アイテム検索) + - [インデックス階層取得](#インデックス階層取得) +- [アイテム詳細画面](#アイテム詳細画面) + - [アイテム詳細取得](#アイテム詳細取得) + - [アイテム検索](#アイテム検索) + - [インデックス階層取得](#インデックス階層取得) + - [ダウンロードランキング取得](#ダウンロードランキング取得) + - [添付ファイルダウンロード](#添付ファイルダウンロード) + - [プロジェクトURLへのアクセス](#プロジェクトURLへのアクセス) + - [リクエストメール送信](#リクエストメール送信) + - [OAI-PMHエクスポート](#oai-pmhエクスポート) + - [OtherFormatsエクスポート](#otherformatsエクスポート) +- [アイテム検索結果画面](#アイテム検索結果画面) + - [アイテム情報取得](#アイテム情報取得) + - [アイテム検索](#アイテム検索) + - [アイテム一括ダウンロード](#アイテム一括ダウンロード) +- [ファイル一覧画面](#ファイル一覧画面) + - [ファイル詳細取得](#ファイル詳細取得) + - [ファイル単一ダウンロード](#ファイル単一ダウンロード) + - [ファイル選択ダウンロード](#ファイル選択ダウンロード) + - [ファイル一括ダウンロード](#ファイル一括ダウンロード) + - [ファイルプレビュー](#ファイルプレビュー) +- [インデックス画面](#インデックス画面) + - [アイテム情報取得](#アイテム情報取得) + - [アイテム検索](#アイテム検索) + - [親インデックス階層取得](#親インデックス階層取得) + - [アイテム一括ダウンロード](#アイテム一括ダウンロード) + +## TOP画面 + +エンドポイント: `/` + +### アイテム最新情報取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム検索 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### インデックス階層取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +## アイテム詳細画面 + +エンドポイント: `/ams/detail?sess=search?number=<アイテムID>` + +### アイテム詳細取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム検索 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### インデックス階層取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### ダウンロードランキング取得 + +アイテムにファイルが添付されているとランキングを取得します。 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### 添付ファイルダウンロード + +アイテムにファイルが添付されているとダウンロード出来ます。 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### プロジェクトURLへのアクセス + +アイテムのメタデータにプロジェクトURLが設定されている場合に[GRDM]ボタンが表示され、本機能が利用出来ます。 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### リクエストメール送信 + +アイテムのメタデータにプロジェクトURLが設定されていない、かつ`リクエストメールアドレス`が設定されている場合に[リクエスト]ボタンが表示され、本機能が利用出来ます。 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### OAI-PMHエクスポート + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### OtherFormatsエクスポート + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +## アイテム検索結果画面 + +エンドポイント: `/ams/search` + +### アイテム情報取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム検索 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム一括ダウンロード + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +## ファイル一覧画面 + +エンドポイント: `/ams/files?number=<アイテムID>` + +### ファイル詳細取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### ファイル単一ダウンロード + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +※ ファイルの格納場所がWEKO3外部の場合は、該当するファイルの[ダウンロード]ボタンが非表示になり、ダウンロード出来ません。 + +### ファイル選択ダウンロード + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +※ ファイルの格納場所がWEKO3外部の場合は、該当するファイルの[チェックボックス]が非表示になり、選択出来ません。 + +### ファイル一括ダウンロード + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +※ ファイルの格納場所がWEKO3外部の場合は、該当するファイル**以外**がダウンロードされます。 + +### ファイルプレビュー + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +## インデックス画面 + +エンドポイント: `/ams/search/<インデックスID>` + +### アイテム情報取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム検索 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### 親インデックス階層取得 + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +### アイテム一括ダウンロード + +- 特定グループ所属ユーザ + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | - | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | ○ | ○ | ○ | - | + +- 特定グループ所属ユーザ以外 + +| アイテム/ロール | システム
管理者 | リポジトリ
管理者 | コミュニティ
管理者 | 登録ユーザー | 一般ユーザー | ゲスト
(未ログイン) | +| ------------------------ | ------------------ | -------------------- | ------------------------- | ------------ | ------------ | ---------------------- | +| オープンアクセス | ○ | ○ | ○ | ○ | ○ | ○ | +| 特定グループ所属ユーザ
のみ閲覧可能アイテム | ○ | ○ | × | × | × | × | + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +| ---------- | ------------------------------------------ | -------------------------------------------------------- | +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/ams/AMS_ARCHITECTURE_01.md b/docs/spec/base/ams/AMS_ARCHITECTURE_01.md new file mode 100644 index 00000000..ab84f65a --- /dev/null +++ b/docs/spec/base/ams/AMS_ARCHITECTURE_01.md @@ -0,0 +1,70 @@ +## 未病データベースとWEKOの構成 + +未病データベースとWEKOの構成を記述する。 + +### 用語説明 + +本書では以下の用語で統一する。 + +| 用語 | 説明 | +| ---- | ---- | +| フロント | 未病データベースのフロントエンド | +| WEKO | 未病データベース用のWEKO3リポジトリ（バックエンド） | + +### フロントのパス一覧 + +以下はNuxtアプリケーションで動作する画面のパスであり、 各ページの動作は `weko-frontend/pages` ディレクトリ内のファイルで定義されている。 + +| パス | 説明 | +|--------------------------------------------------|-------------------------------------------------------------| +| / | トップ画面 | +| /ams/search | 検索画面 | +| /ams/contact | お問い合わせ画面 | +| /ams/detail | アイテム詳細画面 | +| /ams/files | ファイル一覧画面 | +| /ams/login | ログイン画面 | +| /ams/logout | ログアウト画面 | + +以下はNuxtアプリケーションのサーバーサイドで動作するAPIのパスであり、 各APIの動作は `weko-frontend/server` ディレクトリ内のファイルで定義されている。 + +| APIパス | メソッド | 説明 | +|-------------------------------------------------|:--------:|-----------------------------------------------------------| +| /api/ams/captcha/<アイテムのID>/request-mail | POST | WEKOのリクエストメール送信APIにリクエストを送信するAPI | +| /api/ams/captcha/image | GET | WEKOのCAPTCHA画像取得APIにリクエストを送信するAPI | +| /api/ams/captcha/validate | POST | WEKOのCAPTCHA結果検証APIにリクエストを送信するAPI | +| /api/ams/mail/send | POST | メール送信API | +| /api/ams/token/create | GET | WEKOからアクセストークンを初回取得するためのAPI | +| /api/ams/token/refresh | GET | WEKOからアクセストークンを再度取得するためのAPI | + + +### フロントとWEKOの共存 + +フロントとWEKOを同一オリジンで動作させる。 +フロントとWEKOの画面の両方を表示、またはフロントの画面のみを表示可能とする。 + +#### フロントとWEKOの両方の画面を表示 + +nginxの設定により、リクエストされたパスに応じてアクセス先のアプリケーションを振り分ける。 +これにより、フロントとWEKOの両方の画面を表示できる。 +WEKO単体で動作している場合と比較し、アクセスできない画面はWEKOのトップ画面のみとなる。 +nginxコンテナの`/etc/nginx/conf.d/weko.conf`に`weko/nginx/weko-ams.conf`の内容を設定した場合、この動作となる。 + +| パス | アクセス先アプリケーション| 説明 | +|--------------|:---------- |-----------------------------------------| +| / | フロント | フロントのトップ画面 | +| /ams/* | フロント | フロントの各画面
`/ams`および`/ams/`にアクセスした場合は`/`にリダイレクトする | +| /api/ams/* | フロント | フロントのサーバーサイドで動作するAPI | +| /img/ams/* | フロント | フロントで使用する画像 | +| 上記以外 | WEKO | WEKOの画面、APIなど | + +#### フロントの画面のみを表示 + +nginxの設定を変更することで、WEKOへのアクセスを制限する。 +フロントの動作に必要なものを除き、WEKOの画面やAPIへのアクセスを制限し、フロントの画面のみにアクセスできるようにする。 +nginxコンテナの`/etc/nginx/conf.d/weko.conf`に`weko/nginx/weko-ams-restricted.conf`の内容を設定した場合、この動作となる。 + +### 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +|--------------|------------------|------------| +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/ams/AMS_GRDM_BUTTON_01.md b/docs/spec/base/ams/AMS_GRDM_BUTTON_01.md new file mode 100644 index 00000000..dc4f0a26 --- /dev/null +++ b/docs/spec/base/ams/AMS_GRDM_BUTTON_01.md @@ -0,0 +1,74 @@ +## 未病データベース GakuNin RDMボタン表示 + +アイテム詳細画面のGakuNin RDM(以下GRDM)ボタンの表示について記述する。 + +### 用語説明 + +本書では以下の用語で統一する。 + + | 用語 | 説明 | + | ---- | ---- | + | フロント | 未病データベースのフロントエンド | + | WEKO | 未病データベース用のWEKO3リポジトリ（バックエンド） | + | プロジェクトURL | GRDMのプロジェクトや共有リクエストのURL | + +### 1. RO-CrateからWEKOのアイテムへの変換 + +プロジェクトURLはRO-Crate内で`ams:projectId`として記述される。 +WEKOのJSON-LDマッピング機能( [ADMIN_1_5：JSON-LDマッピング](../admin/ADMIN_1_5.md) )を使用して、 +`ams:projectId`を未病アイテムタイプのプロジェクトURL(関連情報プロパティ)にマッピングする。 + +`ams:projectId`を`プロジェクトURL.関連識別子.関連識別子`にマッピングする。(以下、関連識別子とする。) +`プロジェクトURL.関連タイプ`には固定値で後述の`grdm.relationType` の値をマッピングする。(以下、関連タイプとする。) +JSON-LDマッピング機能により、`ams:projectId`が存在する場合のみ関連タイプが登録される。 + +- RO-Crateの例 + ```json + "@id": "./", + "@type": "Dataset", + "name": "Sample Dataset", + "description": "This is a sample dataset.", + "datePublished": "2025-03-01", + "ams:projectId":{ + "value": "https://rdm.nii.ac.jp/" + } + ``` + +- RO-Crateに対応するマッピング定義の例 + ```json + "プロジェクトURL": "ams:projectId", + "プロジェクトURL.関連識別子.関連識別子": "ams:projectId.value", + "プロジェクトURL.関連タイプ": "$isVersionOf", + ``` + +### 2. WEKOのアイテムからRO-Crateへの変換 + +アイテム取得API (`/api/v1/records/<アイテムID>`)使用時、 +WEKOのRO-Crateマッピング機能を使用し、関連識別子と関連タイプを以下のキーにマッピングする。 + +- 関連識別子 + - ツリー構造: root > プロジェクトURL > URL > URL + - RO-Crateのキー: `text` +- 関連タイプ + - ツリー構造: root > プロジェクトURL > 関連タイプ > 関連タイプ + - RO-Crateのキー: `text` + +### 3. フロントでのGRDMボタン表示 + +WEKOのアイテム詳細情報取得APIを使用し、RO-Crateから関連識別子と関連タイプを取得する。 +関連識別子と関連タイプが以下の2条件を共にみたす場合、関連識別子をプロジェクトURLとして扱う。 + +- `nginx/ams/weko-frontend/app.config.ts` で設定した `grdm.url` の値が`''`(空文字列)の場合、関連識別子が空でないこと + `nginx/ams/weko-frontend/app.config.ts` で設定した `grdm.url` の値が`''`(空文字列)でない場合、関連識別子が `grdm.url` の値から始まること + +- 関連タイプが `nginx/ams/weko-frontend/app.config.ts` で設定した `grdm.relationType` の値と一致すること + +プロジェクトURLが設定されている場合、ユーザのログイン状態に関わらずアイテム詳細画面にGRDMボタンを表示する。 +ユーザがGRDMボタンを押下した場合は、プロジェクトURLを新規ウィンドウで開く。 +GRDMボタンを表示している場合、リクエストボタンとその表示領域は非表示とする。 + +### 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +|--------------|------------------|------------| +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/ams/AMS_SHIBBOLETH_01.md b/docs/spec/base/ams/AMS_SHIBBOLETH_01.md new file mode 100644 index 00000000..b9db1714 --- /dev/null +++ b/docs/spec/base/ams/AMS_SHIBBOLETH_01.md @@ -0,0 +1,126 @@ +## 未病データベース Shibboleth対応 + +### 用語説明 + +- 本書では以下の用語で統一する + + | 用語 | 説明 | + | ---- | ---- | + | フロント | 未病データベースのフロントエンド | + | WEKO | 未病データベース用のWEKO3リポジトリ（バックエンド） | + | Shibbolethログイン | 学認IdPやOrthrosアカウントによるログイン | + +### 1\. Shibbolethログイン時のロール付与 + +- WEKOの処理に変更を加えず使用する + +- WEKOのShibboleth対応については[SHIBBOLETH_01](../other/SHIBBOLETH_01.md)を参照 + +- IdPから取得した属性情報はWEKOに渡され、所属グループの判定を行う + + - 所属グループが「目標2Grp」である場合、対応するロールを付与することにより、目標2ユーザとしてアクセス権限を付与する + + - 属性情報からmAPグループID: `jc__groups_` に所属しているか判定する (`` に目標2Grpの値が入る) + + - 所属グループが「目標2Grp」ではない場合、通常通りログインする + + +### 2\. Shibbolethログインの実装 + +- nginx/ams/weko-frontend/pages/login.vueのonMounted関数でEmbedded DSを導入する + + - Embedded DSの導入にはiframeを活用する + + - Embedded DSを導入する際に必要な変数をnginx/ams/weko-frontend/app.config.tsで定義する + + ```js + const weko = 'xxx'; //ホスト名を設定 + + shibLogin: { + dsURL: 'https://ds.gakunin.nii.ac.jp/WAYF', + orthrosURL: 'https://core.orthros.gakunin.nii.ac.jp/idp', + entityID: 'https://' + weko + '/shibboleth', + handlerURL: 'https://' + weko + '/Shibboleth.sso', + returnURL: 'https://' + weko + '/secure/login.py?next=ams' + } + ``` + + - /secure/login.pyからweko_accounts\.views\.shib_sp_login関数を実行する + +- weko_accounts\.views\.shib_sp_login関数によって、IdPからのリクエストを処理する + + - 参考： [SHIBBOLETH_01: 5\.実装](../other/SHIBBOLETH_01.md) + + - ログイン処理後のリダイレクト先はフロントのTOPページを指定する + +- ログイン処理後、nginx/ams/weko-frontend/pages/index.vueからOAuth2 APIを実行する + + - 参考： [OAuth2 API](../api/API_01_Oauth2.md) + + - ユーザがトークン発行を許可することで認可コードを受け取ることが出来る + +### 3\. Shibbolethログイン、OAuth認証時のエラー + +- Shibbolethログイン、およびトークン取得時のエラー内容は以下の通り + 検知したエラーはログイン画面、OAuth認証画面でそれぞれ表示する + + - ログイン画面 + + | エラー原因 | ステータスコード | レスポンス | エラーメッセージ（日/英） | + | --------- | --------------- | --------- | ----------------------- | + | WEKOでログインブロックされている | 403 | Login is blocked. | ログインに失敗しました。管理者に連絡してください。
/Failed to Login. Please contact server administrator. | + | 登録ユーザー情報がない | 403 | There is no user information. | ユーザー情報がありません。
/There is no user information. | + | Redisにcache_keyがない | 400 | Missing SHIB_CACHE_PREFIX! | ログインに失敗しました。管理者に連絡してください。
/Failed to Login. Please contact server administrator. | + | Shibboleth-Session-IDが取得出来ない | 400 | Missing Shib-Session-ID! | ログインに失敗しました。管理者に連絡してください。
/Failed to Login. Please contact server administrator. | + | shib_eppnが取得出来ない | 400 | Missing SHIB_ATTRs! | ログインに失敗しました。管理者に連絡してください。
/Failed to Login. Please contact server administrator. | + + - OAuth認証画面 + + | エラー原因 | ステータスコード | レスポンス | エラーメッセージ（日/英） | + | --------- | --------------- | --------- | ----------------------- | + | レスポンスタイプ誤り | 400 | This response type is not supported. | このレスポンスタイプはサポートされていません。
/This response type is not supported. | + | クライアントID誤り | 400 | The client ID is incorrect. | クライアントIDに誤りがあります。
/The client ID is incorrect. | + | スコープ誤り | 400 | The scope is incorrect. | スコープに誤りがあります。
/The scope is incorrect. | + | ユーザーが【Reject】を選択 | 200 | Access has been denied. | アクセスが拒否されました。
/Access has been denied. | + +### 4\. 目標2ユーザ以外が閲覧権限が必要なアイテム詳細画面にアクセスした場合 + +- 未ログインユーザが閲覧権限が必要なアイテム詳細画面にアクセスした場合 + + - アイテム閲覧にはログインが必要であるというメッセージを表示し、xx秒後に自動でフロントのログイン画面に遷移する + + - xx(秒数)はnginx/ams/weko-frontend/app.config.tsで指定する + + - defineAppConfig関数に`transitionTimeMs:xx` (ミリ秒)を追加する + + - デフォルト値は10000(=10秒) + + - アイテム詳細画面からログイン画面にリダイレクトする際に、nginx/ams/weko-frontend/pages/detail.vueで以下処理を実行する + + - アイテム詳細画面のURLを`sessionStorage`に保存する + + - navigateTo関数のパスに`/login`と、クエリに`source=detail`を指定する + + - ログイン画面へ遷移時、クエリに`source=detail`がない場合はnginx/ams/weko-frontend/pages/login.vueの`onBeforeMount`で`sessionStorage`のアイテム詳細画面URLを削除する + + - nginx/ams/weko-frontend/pages/index.vueでOAuth2 APIを実行する際にリダイレクト先をアイテム詳細画面のURLに指定する + + - API実行前にそれぞれの変数を指定する + ```js + const baseURI = useRuntimeConfig().public.redirectURI; + const itemURL = sessionStorage.getItem('item-url'); + const redirectURL = itemURL ? itemURL : baseURI; + ``` + + - `itemURL`に値を設定した後、`sessionStorage`のアイテム詳細画面URLを削除する + + - `finally`の`useRouter().replace()`のパスに`redirectURL`を指定する + +- 目標2ユーザ以外のログインユーザが閲覧権限のないアイテム詳細画面にアクセスした場合 + - アイテムの閲覧権限がないというエラーメッセージを表示する + +## 更新履歴 + +| 日付 | GitHubコミットID | 更新内容 | +|--------------|------------------|------------| +| 2025/08/29 | 6ee63da44c8f2e23ac73d6218ee09f23ba5edcb3 | 初版作成 | diff --git a/docs/spec/base/api/API_01_Oauth2.md b/docs/spec/base/api/API_01_Oauth2.md index 2bbead6c..a552984c 100644 --- a/docs/spec/base/api/API_01_Oauth2.md +++ b/docs/spec/base/api/API_01_Oauth2.md @@ -14,7 +14,7 @@ API-8-5の機能を用いて、OAuthアプリケーション、またはトー - 【アカウント(Account)\>Applications】画面にてOAuthアプリケーション、OAuthトークンを登録することができる。 - - 詳細は[USER-8-5 API設定](https://ivis.sharepoint.com/sites/NIIDMR646/Shared%20Documents/%5bWEKO3%5d10_開発/01.開発/2023/JAIRO%20Cloud（WEKO3）のドキュメント整備/機能設計書/マージ前/機能設計書_WebAPI_API-1-6.docx#_API設定)を参照すること + - 詳細は[USER-8-5 API設定](../user/USER_8_5.md)を参照すること **Authorize URL (GET) /oauth/authorize** @@ -56,6 +56,13 @@ Query parametersの値を以下とする。 > > 「Authorize application」ボタンを押下すると、codeとstateの値がサーバー側からクライアント側に渡される。 +レスポンスコード + + | コード | 説明 | + | ------ | ------------------------------------------------------------- | + | 200 | ・正常終了
・ユーザが OAuth 認証画面で Reject を押下した時 | + | 400 | リクエストに不備がある時 | + **Access token URL (POST) /oauth/token** Request body parameters: @@ -108,6 +115,13 @@ Request body parametersを以下のものだとする。 > > request = requests.post(url=accessurl, data=params) +レスポンスコード + + | コード | 説明 | + | ------ | ------------------------------------------------------------- | + | 200 | 正常終了| + | 400 | リクエストに不備がある時 | + **アクセストークンの発行** Personal access tokens の新規発行(/account/settings/applications/tokens/new/)からアクセストークンを発行することができる。 @@ -225,7 +239,7 @@ url, headers, body = oauth.prepare_token_request('https://dev.ir.rcos.nii.ac.jp/ - > 関連モジュール -> invenio\_oauth2server +> invenio\_oauth2server - > 更新履歴 @@ -252,5 +266,12 @@ url, headers, body = oauth.prepare_token_request('https://dev.ir.rcos.nii.ac.jp/ 7733de131da9ad59ab591b2df1c70ddefcfcad98 v1.0.7対応 + +
+

2025/06/11

+
+ +レスポンスコードを追記 + diff --git a/docs/spec/base/api/API_05_index_op.md b/docs/spec/base/api/API_05_index_op.md index 2c2b90bd..589fddfa 100644 --- a/docs/spec/base/api/API_05_index_op.md +++ b/docs/spec/base/api/API_05_index_op.md @@ -240,8 +240,8 @@ $ curl -k "https://192.168.56.200/api/v1/tree/1623632832836" -H "Authorization:B 全インデックスあるいは指定したインデックスの情報を取得する。 #### エンドポイント -GET /api//tree：全インデックス -GET /api//tree/：指定したインデックス +GET /api/\/tree：全インデックス +GET /api/\/tree/：指定したインデックス #### リクエストヘッダー @@ -315,7 +315,7 @@ GET /api//tree/：指定したインデックス インデックスを新規作成する。 #### エンドポイント -POST /api//tree/index +POST /api/\/tree/index #### リクエストヘッダー @@ -382,7 +382,7 @@ POST /api//tree/index 指定したインデックスの情報を更新する。 #### エンドポイント -PUT /api//tree/index/ +PUT /api/\/tree/index/ #### リクエストヘッダー @@ -429,7 +429,7 @@ PUT /api//tree/index/ 指定したインデックスを削除する。 #### エンドポイント -DELETE /api//tree/index/ +DELETE /api/\/tree/index/ #### リクエストヘッダー @@ -469,4 +469,3 @@ DELETE /api//tree/index/ | ---------- | ------------------------------------------ | -------------------------------------------------------- | | 2023/08/31 | 353ba1deb094af5056a58bb40f07596b8e95a562 | 初版作成 | | 2025/06/06 | 34a972ec2f7a26b92cb55cb4524b20bdde180f39 | インデックス管理APIについて追記 | - diff --git a/docs/spec/base/media/media/image37.png b/docs/spec/base/media/media/image37.png new file mode 100644 index 00000000..4c3dc482 Binary files /dev/null and b/docs/spec/base/media/media/image37.png differ