> For AI agents: the complete documentation index is available at /resource/ucidm/docs/on-premise/llms.txt, the full documentation bundle is available at /resource/ucidm/docs/on-premise/llms-full.txt. # ID 連携管理画面 \{#id-federation-admin} UCIDM では ID 連携管理画面があり、主に以下の画面を提供しています。 ## ID 連携管理画面へのアクセス \{#accessing-admin-ui} ID 連携管理画面へのアクセス URL は環境によって異なるので、compose.yml の admin-ui の設定および nginx の設定を参照の上、アクセスを行ってください。 ## トップ画面 \{#top-page} ID 連携管理画面にアクセスするとトップ画面が表示されます。 「ログイン」ボタンを押下するとログイン画面に遷移します。 ## ログイン画面 \{#login-page} ユーザー名/パスワードを入力し、「ログイン」ボタンを押下してログインを行います。「パスワードが不明な場合」を押下することで、パスワードリセット申請画面に遷移します。 ## パスワードリセット申請画面 \{#password-reset-request} パスワードリセットを行う管理者名とメールアドレスを入力します。メールアドレスが設定されていない場合、パスワードリセットを行うことはできません。入力情報が正しい場合、入力されたメールアドレスに一時トークンが送信され、パスワードリセット画面に遷移します。 ## パスワードリセット画面 \{#password-reset} 送られてきたメールに記述された一時トークン、新しいパスワード、新しいパスワード（確認）を入力し、「再設定」ボタンを押下することで、パスワードをリセットできます。 ## ログイン後トップ画面 \{#post-login-top} 以下の画面に遷移するボタンが表示されます。 - 履歴一覧 - ID 連携進捗状況 - 外部連携設定 - ユーザー・グループ管理 - システム管理 画面右上にはログイン名が表示されたボタンがあり、このボタンを押下することで以下の各種メニューが表示されます。 - アカウント情報 - 管理者アカウント詳細画面に遷移します。 - パスワード変更 - 管理者アカウントパスワード変更画面に遷移します。 - ログアウト - このリンクをクリックすることで、ログアウトが行われます。 ## 履歴一覧 \{#history-list} - 以下の履歴タイプごとのタブが表示されます。タブを押下することで、それぞれの履歴が一覧表示されます。 - ID 連携履歴 - 外部サービスへの連携履歴の確認が行えます。 - 連携時に更新されたデータの差分を確認できます。 - 認証履歴 - 認証の履歴を確認できます。 - LDAP 操作履歴 - LDAP に対する操作の履歴を確認できます。 - UCIDM 内部履歴 - UCIDM 内部のサーバーログの履歴を確認できます。 - 一括処理履歴 - CSV 一括処理の履歴、ユーザー無効日チェックなどの一括処理の履歴を確認できます。 - スケジューラー履歴 - スケジューラー関連の履歴を確認できます。 - 全ての履歴 - 上記 6 つの履歴の主要情報をまとめて確認できます。 - マイグレーション履歴 - UCIDM のバージョンアップなどの際に必要なデータ移行のマイグレーション履歴を確認できます。 ## ID 連携進捗状況 \{#idfederation-progress-summary} - 一括連携時など進捗状況の概要を確認したいといった際に視覚的に ID 連携の状況を確認できる画面です。 - 棒グラフ形式で 完了/失敗/進捗中 の状況を期間を絞って確認できます。 - 「実行中の ID 連携を見る」ボタンを押下することで、実行中の ID 連携画面に遷移できます。 ## 実行中の ID 連携 \{#running-idfederations} - 実行中 ID 連携情報を一覧表示します。 - 実行中の ID 連携情報の検索が行えます。 ## 外部連携設定画面 \{#external-federation-settings} - 外部連携設定を一覧表示します。 - 一覧表示された画面にて、「作成」ボタンを押下すると、新規外部連携設定画面に遷移します。 - ここでは、対象の外部連携先や、マッピングを指定できます。 - 外部連携先に対応する Queue が存在していない場合は、この Queue が新規で作られます。 - 外部連携する対象を指定できるルーティング設定もここで行えます。 - 一覧表示された画面にて、鉛筆マークの「編集」アイコンを押下すると、外部連携詳細画面に遷移します。 - 外部連携詳細画面では、既存の外部連携設定を確認できます。また、内容を編集し、「更新」ボタンを押下すると、外部連携の設定内容を更新できます。 - 外部連携詳細画面の「削除」ボタンを押下すると、連携設定が削除されます。また、対象の外部連携先に対する連携設定が他にない場合は、対象の外部連携先設定および対応する Queue が削除されます。 - 一覧表示された画面にて、ゴミ箱マークの「削除」アイコンを押下すると、連携設定が削除されます。また、対象の外部連携先に対する連携設定が他にない場合は、対象の外部連携設定および対応する Queue が削除されます。（ - 1 つの外部連携先においてマッピングをエントリの内容に応じて切り替えたい場合は、対象の外部連携先における複数の連携設定を作成する必要があります。（外部連携先 ID を同じにして、マッピングの内容をそれぞれ設定してください。） - ルーティング設定については、後述のルーティング設定の項の内容を参考にしてください。 - メンバーシップブリッジ設定については、後述のメンバーシップブリッジ設定の項の内容を参考にしてください。 ### ルーティング設定 \{#external-federation-routing} - ルーティング設定においては、以下の情報を指定する必要があります。 - ルート ID - 新規 ルーティング作成画面においては、一意のルート ID を指定する必要があります。 - 連携条件 - ユーザー用とグループ用のそれぞれの連携条件を指定できます - 条件に合致するレコードのみが指定された外部連携設定に則って連携されます - グループメンバー追加/削除の連携については、グループとメンバーとなるユーザーのそれぞれの連携条件を見て連携の可否が判定されます - 「常に連携」を選んだ場合は、すべてのエントリが連携 ID で指定された連携設定に則って連携されます - 「条件を指定」を選んだ場合は、連携対象のエントリを絞り込むことができます。この時、条件設定欄が下部に表示されます。 - 条件設定欄では、条件エディタでグラフィカルに対象のエントリを指定できます。JSON のタグを開くことで生データを確認することもでき、JSON を直接編集することもできますが、JSON の構造が複雑なため、出来る限り条件エディタでの編集をお勧めいたします。 - 条件エディタでは、AND 条件、OR 条件での条件指定が可能です。 - 条件エディタでは、DN、PrimaryID を始め、エントリの作成/更新日時や、属性値でのフィルタを指定できます。 - 比較値が数値（number）、時刻（time）の場合は大小関係を指定できます。また、複数の大小関係を指定できます。 - 属性値でのフィルタの場合、比較値の型を指定できます。（string, number, boolean, time） ### メンバーシップブリッジ設定 \{#external-federation-membership-bridge} - メンバーシップブリッジ設定を行えます。以下の値を設定します。 - グループ DN - ブリッジ対象のメンバーシップグループを指定します。 - 離脱時動作 - ユーザーがグループから離脱したときの外部連携先ユーザーの扱いを選択します。 - 「削除」を選択した場合、ユーザーがグループから離脱した際に、外部連携先の対象のユーザーを削除します。 - 「無効化」を選択した場合、ユーザーがグループから離脱した際に、外部連携先の対象のユーザーを論理的に無効化します。 - パスワード属性 - プロビジョニング用パスワードを取得する属性名を指定します。空欄の場合はパスワードを連携しません。 - メンバーシップブリッジ設定を利用する - 有効の場合のみ、このメンバーシップブリッジ設定に則って外部連携が行われます。 - 説明 ## ユーザー・グループ管理画面 \{#users-groups-page} - UCIDM の MongoDB に登録されている以下情報を一覧表示します。表示される情報はタブで切り替えが可能です。 - 連携対象となっているユーザー - 連携対象となっているグループ - 連携対象外となっているユーザー - 連携対象外となっているグループ - 連携対象のユーザー・グループについて、「対象から外す」ボタンを押下することで、そのユーザー・グループを連携対象から外すことができます。 - 連携対象外のユーザー・グループについて、「対象にする」ボタンを押下することで、そのユーザー・グループを連携対象にできます。 - 各ユーザー・グループの DN を押下すると、ユーザー詳細画面・グループ詳細画面が表示されます。 - 新規対象外のユーザー（UCIDM に連携済みでないユーザー）を追加できます。 - 連携対象外としたい DN の情報を入力します。 - primaryID と entryUUID については明示的に指定したい場合のみ入力してください。 - entryUUID には以下の情報を入力してください - 連携元システムが LDAP の場合 - LDAP における対象ユーザーの entryUUID の値 - 連携元システムが AD の場合 - AD における対象ユーザーの objectGUID の値 - 連携元システムが ME-ID の場合 - ME-ID における対象ユーザーの Object ID の値 ## システム管理画面 \{#system-management} 以下の画面に遷移するボタンが表示されます。 - 管理者アカウント - システムロール - カスタムロール - システム設定 - スケジュール設定 - ログインロックアウト - タスクキュー - 設定のエクスポート/インポート ## 管理者アカウント画面 \{#admin-accounts} - UCIDM の管理画面へログインできる管理者アカウントを一覧表示します。 - 一覧表示された画面にて、「作成」ボタンを押下すると、管理者アカウント新規作成画面に遷移します。 - 一覧表示された画面にて、鉛筆マークの「編集」アイコンを押下すると、管理者アカウント詳細画面に遷移します。 - 編集はログインしているアカウント自身のみ行えます。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、すべてのアカウントの編集を行えます。 - 一覧表示された画面にて、鍵マークの「編集」アイコンを押下すると、管理者アカウントパスワード変更画面に遷移します。 - パスワード変更はログインしているアカウント自身のみ行えます。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、すべてのアカウントの編集を行えます。 - 一覧表示された画面にて、ゴミ箱マークの「削除」アイコンを押下すると、管理者アカウントが削除されます。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、他のアカウントの削除を行えます。 - 自分自身のアカウントは削除できません。 ## 管理者アカウント新規作成画面 \{#create-admin-account} - 新規作成画面で設定内容を入力し、画面下部の「作成」を押下すると新規管理者アカウントが作成されます。ユーザー名とパスワードは必ず入力する必要があります。 - ユーザー名はアルファベット文字、数字、ハイフン、アンダースコアが使えます。 - アカウント作成時は以下ページのシステムロール/カスタムロールから適切なロールを指定してください。 - [ロールとアクセス制御](/resource/ucidm/docs/on-premise/administration/admin-ui/role.md) - 以下の各種設定も行うことができます。 - 言語 - ID 連携管理画面の表示言語を設定します。 - タイムゾーン - ID 連携管理画面上で表示したい時刻のタイムゾーンを設定します。 - ページ当たりの表示件数 - ID 連携管理画面の履歴一覧画面等のページで 1 ページあたりに表示されるデフォルトの件数を設定します。 - 表示項目 - ID 連携管理画面の履歴一覧画面や実行中ジョブ一覧画面等のページでデフォルトで表示したい項目を設定します。 ## 管理者アカウント詳細画面 \{#admin-account-details} - 管理者アカウント情報の確認・編集が行えます。 - 管理者アカウント新規作成画面と同様に、以下の各種設定も行えます。 - 言語 - タイムゾーン - ページ当たりの表示件数 - 表示項目 ## 管理者アカウントパスワード変更画面 \{#admin-password-change} - 管理者アカウントのパスワード変更が行えます。 ## システムロール一覧画面 \{#system-roles-list} - 設定されているシステムロールを一覧表示します。 - system-agent 以外のシステムロールでは画面表示の設定を行えます。 - 「画面表示」アイコンを押下することで画面表示の詳細画面に遷移します。 ## システムロール画面表示設定画面 \{#system-role-display-settings} - ユーザープロファイルでの画面表示の設定を行えます。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、設定内容の編集を行えます。 ## カスタムロール一覧画面 \{#custom-roles-list} - 設定されているカスタムロールを一覧表示します。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、カスタムロールの追加を行えます。 - 一覧テーブル右上の追加ボタンを押下することで、カスタムロール新規作成画面に遷移します。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、カスタムロールの削除を行えます。 - 「画面表示」アイコンを押下することで画面表示の詳細画面に遷移します。 ## カスタムロール新規作成画面 \{#create-custom-role} - カスタムロールの新規作成が行えます。 - カスタムロール名は必ず設定する必要があります。 - 説明は任意項目となります。 - 継承ロールは以下ページのシステムロールから継承元にしたいロールを選択してください。追加で付与する権限については以下ページの権限から必要となる権限を選択してください。 - [ロールとアクセス制御](/resource/ucidm/docs/on-premise/administration/admin-ui/role.md) ## カスタムロール詳細画面 \{#custom-role-details} - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、カスタムロールの確認・編集が行えます。 - 管理者アカウント新規作成画面と同様に、以下の各種設定も行えます。 - 説明 - 継承ロール - 追加で付与する権限 ## カスタムロール画面表示設定画面 \{#custom-role-display-settings} - ユーザープロファイルでの画面表示の設定を行えます。 - system-superadmin などアカウント編集権限のあるロールでログインしている場合は、設定内容の編集を行えます。 - 継承ロールの画面表示設定を使用するか、独自に画面表示設定を定義するかを選べます。 ## システム設定一覧画面 \{#system-settings-list} - システム設定セクションの一覧が表示されます。 - 各セクションの詳細ボタンを押下することで、設定詳細画面に遷移します。 - system-superadmin のロールでログインしている場合は、UCIDM API の再起動を行えます。 ## システム設定詳細画面 \{#system-settings-details} - システム設定各セクションの設定名、設定値が表示されます。 - system-superadmin のロールでログインしている場合は、設定内容の編集を行えます。 ## スケジュール設定画面 \{#schedule-settings} - スケジュールタスクの確認、登録、更新、削除が行えます。 - スケジュールの登録、更新においては以下の値を指定する必要があります。 - スケジュール ID - 登録時のみ指定します。 - 更新はできません。 - 他と被らない文字列を指定してください。 - 種別 - 定期実行 - 定期的に実行したい場合はこちらを選択してください。 - 指定日時に実行 - 指定日時に一度のみ実行したい場合はこちらを選択してください。 - 実行間隔 - 定期実行の場合は必ず設定する必要があります。 - 15m, 24h などの値を指定できます。 - 開始時刻 - 指定日時に実行の場合は必ず設定する必要があります。 - タスクを実施したい日時を指定してください。 - タスク名 - 以下から選択してください。 - ユーザー無効日チェック - ソース LDAP のユーザー無効日の属性の値を見て、これより前の日付が入っているエントリのステータスを無効に変更します。 - ユーザー有効日チェック - ソース LDAP のユーザー有効日の属性の値を見て、これより前の日付が入っているエントリのステータスを有効に変更します。 - ユーザー削除日チェック - ソース LDAP のユーザー削除日の属性の値を見て、これより前の日付が入っているエントリを削除します。 - グループ削除日チェック - ソース LDAP のグループ削除日の属性の値を見て、これより前の日付が入っているエントリを削除します。 - 上記チェック処理で参照する値が LDAP の属性は、ユーザープロファイル（管理者用）の表示・属性値設定のライフサイクルの画面にて設定できます。 - 説明 - スケジュールに関する説明を任意に記述できます。 - 再同期 - スケジュール設定画面の内容は主に MongoDB のレコード情報を元に表示されています。 - 実際にスケジュールを動かしているスケジューラーは UCIDM API の内部で動いていて、この内部のスケジューラーに MongoDB のスケジュール情報を同期しています。 - UCIDM API のスケジューラーにスケジュールが紐づいている場合には、スケジュールの詳細を表示した際、「このスケジュールは現在実行中の UCIDM API スケジューラタスクに関連付けられています。」の文言が表示されます。 - すでに終了している指定日時に実行しているジョブなど、スケジューラーにスケジュールが紐づいていないタスクがあっても必ずしも問題とはなりません。 - 通常意識する必要はありませんが、何らかの理由でMongoDB のスケジュール情報と UCIDM API 内部のスケジューラーの情報を同期したい場合にはこの再同期ボタンを押下してください。 ## ログインロックアウト画面 \{#login-lockout} - UCIDM へのログインロックアウト情報を一覧表示します。 - 試行回数が 1 以上の場合、詳細ボタンを押下することで、ログイン失敗理由の情報を確認できます。 - 対象のレコードの削除ボタンを押下することで、ログイン試行失敗の情報の削除およびロックアウト状態の取消が行われます。 ## タスクキュー画面 \{#task-queue} - UCIDM のタスクキューの情報を一覧表示します。 - キューやタスクや対象レコードの情報、成功/失敗/待機中などの状態を確認できます。 ## 設定のエクスポート/インポート画面 \{#export-import-settings} - ID 連携管理画面の以下設定をエクスポート/インポートできます。 - 外部連携設定 - ルーティング設定 - メンバーシップブリッジ設定 - 対象外ユーザー - 対象外グループ - スケジュール設定 - システムロール - 画面設定 - カスタムロール - ロール設定 - 画面設定 - システム設定 - システム設定の閲覧権限がある管理者のみエクスポートを行えます - システム設定の編集権限がある管理者のみインポートを行えます - エクスポートファイルは JSON 形式となります。 - エクスポートする対象のデータを指定できます。 - インポートでは、インポートするファイルを指定し、プレビューボタンを押下後、インポート対象のデータを指定してからインポートボタンを押下してください。 - 外部連携設定のインポート時に「ドライランモードでインポートする」の値を on にしておくことで、インポートされる外部連携設定のドライランモードがすべて on になります。 - 外部連携設定およびルート設定において同名の設定が存在する場合は、「すでに同名の設定が存在します。チェックをつけてインポートを行うと設定が更新されます。」のメッセージが表示されます。 - この設定においてチェックをつけてインポートを行うと、インポートファイルに含まれるデータの内容で、外部連携設定およびルート設定の対象レコードが更新されます。