Add consent management documentation and settings

Author: HiguchiKiyoshi

developerguide/src/docs/asciidoc/wam/webaccountmanager/index.adoc

@@ -54,6 +54,141 @@ Preferenceの<<wam_wampreference_settings,settings>>を参照し、各項目を
 ユーザーがパスワードを忘れた際に、事前に設定されている秘密の質問へ回答することにより、ユーザーのメールアドレス宛にパスワードリセットURLを通知します。 +
 Preferenceの<<wam_wampreference_recovery,recovery>>を参照し、各項目を設定してください。
 
+=== 同意管理
+利用規約やプライバシーポリシーなどの同意コンテンツに対するユーザーの同意を管理する機能を提供します。
+
+* 同意コンテンツのバージョン管理 +
+同意コンテンツはSIMPLE_TIMEBASEバージョン管理により管理されます。規約改訂時は新バージョンを登録するだけで自動的に現行版となり、過去バージョンも保持されるため監査が可能です。
+
+* ログイン時の同意チェック +
+認証済みユーザーのリクエストに対して未同意の必須書類が存在する場合、自動的に同意画面へリダイレクトします。全ての必須書類に同意するまでサービスの利用はできません。
+
+* サインアップ時の同意チェック +
+新規ユーザー登録画面に同意コンテンツが表示されます。必須書類に同意しないと登録が完了できません。
+
+* セルフメンテナンス画面での同意管理 +
+セルフメンテナンス画面から、全同意コンテンツの同意状況を確認できます。任意書類に対してはオプトイン（同意付与）/オプトアウト（同意取消）が可能です。
+
+Preferenceの<<wam_wampreference_consent,consent>>を参照し、各項目を設定してください。
+
+同意管理機能では次のEntityを利用します。
+
+.ConsentContent Entity
+同意コンテンツ（利用規約・プライバシーポリシー等）を管理するEntityです。
+
+----
+Entity定義名: wam.consent.ConsentContent
+バージョン管理: SIMPLE_TIMEBASE
+----
+
+同意コンテンツをメンテナンスするためには、GEM／MDCにてEntityViewの設定を行い、画面から操作可能な状態にします。
+バージョン管理はSIMPLE_TIMEBASE方式を採用しており、有効期間（startDate／endDate）に基づいて、現在有効なバージョンが自動的に決定されます。
+規約等の改訂時には、新しいバージョンをINSERTし、startDateを設定するだけで自動的に現行版として適用されます。
+また、過去バージョンもEntityとして保持されるため、監査対応も可能です。
+さらに、ワークフロー機能と組み合わせることで、承認済みのコンテンツのみを公開する運用とすることも可能です。
+
+[cols="1,1,4", options="header"]
+|===
+|プロパティ名
+|型
+|説明
+
+|name
+|String
+|同意コンテンツの識別名（例: `termsOfService`、`privacyPolicy`）
+
+|contentType
+|Select
+|コンテンツの種別。以下のいずれかを指定します。 +
+`SIMPLE`: チェック項目のみ（本文なし） +
+`DOCUMENT`: インラインドキュメント（HTML本文） +
+`FILE`: バイナリファイル +
+`EXTERNAL`: 外部URL
+
+|content
+|String
+|コンテンツ本文（HTML）。`contentType` が `DOCUMENT` または `SIMPLE` の場合に使用します。
+
+|externalContentUrl
+|String
+|外部コンテンツのURL。`contentType` が `EXTERNAL` の場合に使用します。
+
+|contentFile
+|Binary
+|コンテンツファイル。`contentType` が `FILE` の場合に使用します。
+
+|required
+|Boolean
+|この同意コンテンツへの同意がサービス利用に必須かを指定します。 +
+`true`（デフォルト）の場合、未同意ユーザーは同意画面へリダイレクトされます。 +
+`false` の場合、未同意であってもサービス利用が可能です（任意同意）。
+
+|showOnLogin
+|Boolean
+|ログイン時にこのコンテンツの同意確認を表示するかを指定します。 +
+`true` の場合、`required` が `false` であっても、未確認時にログイン後の同意画面に表示されます。
+
+|changeSummary
+|String
+|バージョンアップ時の変更内容の概要。再同意画面でユーザーに変更内容を提示する際に使用されます。
+
+|displayOrder
+|Integer
+|画面上の表示順序。値が小さいほど先に表示されます。未設定の場合は末尾に表示されます。
+|===
+
+.UserConsent Entity
+ユーザーの同意記録を管理するEntityです。
+
+----
+Entity定義名: wam.consent.UserConsent
+----
+
+[cols="1,1,4", options="header"]
+|===
+|プロパティ名
+|型
+|説明
+
+|user
+|Reference
+|同意したユーザー（`mtp.auth.User` への参照）
+
+|userOid
+|String
+|検索用のユーザーOID
+
+|consentContent
+|Reference
+|同意対象のConsentContent（RECORD_BASE参照）。同意時点のバージョンが固定保持されます。
+
+|consented
+|Boolean
+|同意状態。`true`: 同意済み、`false`: 非同意（オプトアウト）
+
+|respondedDate
+|Timestamp
+|同意もしくは非同意の回答日時
+|===
+
+.同意管理の動作概要
+
+. 同意チェック（ログイン後）: +
+`ConsentCheckInterceptor` が認証済みユーザーのリクエストをインターセプトし、未同意の必須書類（または `showOnLogin=true` の書類）が存在する場合、同意画面（`wam/consent/view`）へリダイレクトします。 +
+セッション有効中は一度チェックが完了すると再チェックは行われません（次回ログイン時に再検知）。
+
+. サインアップ時: +
+新規ユーザー登録画面に `required=true` または `showOnLogin=true` の同意コンテンツが表示されます。必須書類の全てに同意しないと登録は完了できません。
+
+. セルフメンテナンス画面: +
+アカウント設定画面の同意管理ページ（`wam/settings/changeConsentView`）から、全同意コンテンツの同意状況を確認できます。 +
+任意書類（`required=false`）に対してはオプトイン（同意付与）/オプトアウト（同意取消）が可能です。必須書類のオプトアウトはできません。
+
+. バージョン更新時: +
+ConsentContentの新バージョンが有効になると、既存の同意記録のバージョンと現行バージョンが不一致となり、次回ログイン時に再同意が求められます。 +
+`changeSummary` に変更内容を記載することで、再同意画面でユーザーに変更点を提示できます。
+
+
 include::setting.adoc[]
 
 include::setup.adoc[]

developerguide/src/docs/asciidoc/wam/webaccountmanager/setting.adoc

@@ -89,6 +89,11 @@ org.iplass.wam.api.WamPreference
 |idProvider
 |<<wam_wampreference_idProvider_yh,idProvider(Yahoo)>>参照
 |
+
+|consent
+|<<wam_wampreference_consent,consent>>参照
+|
+
 |===
 
 [[wam_wampreference_signUp]]
@@ -231,6 +236,34 @@ ReCAPTCHAを使用します。 `version` 項目に使用するバージョンを
 |mail
 |===
 
+[[wam_wampreference_consent]]
+.consent
+同意管理機能の設定です。
+
+[cols="1,4,1", options="header"]
+|===
+|項目
+|説明
+|初期値
+
+|enabled
+|同意管理機能の有効/無効を設定します。 +
+`true` に設定すると、ログイン後のリクエストに対して未同意チェックが有効になります。
+|false
+
+|excludeActionPatterns
+|同意チェックを除外するActionパターン（正規表現）を指定します。複数指定可能です。 +
+ここで指定したパターンに一致するActionに対しては、未同意状態でもリダイレクトが行われません。 +
+デフォルトで `wam/auth/\*`、`wam/signup/\*`、`wam/consent/\*` 等の認証・サインアップ・同意関連Actionは除外されています。
+|
+
+|cacheReloadIntervalSeconds
+|ConsentContent Entityのキャッシュのリロード間隔（秒）を指定します。 +
+0以下の場合はキャッシュが無期限（Entity更新まで）となります。 +
+規約の更新頻度に応じて適切な値を設定してください。
+|0
+|===
+
 [[wam_wampreference_manageSite]]
 .manageSite
 管理対象サイトの設定です。サイト毎に設定します。

overview/src/docs/asciidoc/index_en.adoc

@@ -186,6 +186,9 @@ In addition, the functionalities like mail activation while signing up, and the
 ==== [.eeonly]#Password Reminder#
 We provides the tool-pages to reset passwords for the users who forget about their own passwords.
 
+==== [.eeonly]#Consent Management#
+Provides functionality to manage user consent for consent contents such as terms of service and privacy policies.
+
 ==== [.eeonly]#Static Contents Access Control#
 iPLAss provide the feature of access management on static sites, contents (or the dynamic contents output to CMS servers.) When anonymous user trying to access the limited static contents, they are redirected to the iPLAss login pages. In the case of a logged in user, the system will check whether the user possesses the authority.
 There is no problem to have iPLAss deployed on a different server/ domain from the contents in need for protections.

overview/src/docs/asciidoc/index_ja.adoc

@@ -210,6 +210,9 @@ Facebook、X（Twitter）などのアカウントでログインする機能を
 ==== [.eeonly]#パスワードリマインダ#
 パスワードを失念したユーザーが自らのパスワードをリセットするための機能、画面を提供します。
 
+==== [.eeonly]#同意管理#
+利用規約やプライバシーポリシーなどの同意コンテンツに対するユーザーの同意を管理する機能を提供します。
+
 ==== [.eeonly]#静的コンテンツへのアクセス制御#
 静的サイト、コンテンツ（もしくは動的にコンテンツを出力するCMSサーバなど）へのアクセスをiPLAssで管理する機能を提供します。
 閲覧制限されるコンテンツを表示しようとした場合、未ログインユーザーの場合は、iPLAssログイン画面にリダイレクトします。