Skip to content

Commit 20b932a

Browse files
yomybabyagatha197
authored andcommitted
docs(rbac): align with revoke/remove confirmation flow and localized scope names
Part of the recent main-branch docs catch-up plan (Work Item 6). Source PRs: - FR-2775 (#7155) localize ROLE_ASSIGNMENT and resolve scope name in permission modal - FR-2803 (#7229) Korean RBAC: use 역할 (role) / 동작 (action) - FR-2804 (#7231) Popconfirm-style for reversible RBAC revoke/remove flows - FR-2828 (#7276) adaptive filter input types for RBAC permission/entity queries Changes: - Manage Permissions: scope target now shown as resolved localized name (not raw UUID); permission type label localized. - Remove a Permission / Revoke Users from a Role: documented Popconfirm-style anchored popup (reversible); not typed-confirm. - Korean version: 권한 → 역할 for role semantics; 동작 for operation; 세부 권한 retained for fine-grained permissions — matches resources/i18n/ko.json. - Role List + Permissions tab filter: adaptive input types per selected property. Updated in all 4 languages (en/ko/ja/th). Screenshots flagged with TODO markers.
1 parent 10d4a7e commit 20b932a

4 files changed

Lines changed: 136 additions & 96 deletions

File tree

packages/backend.ai-webui-docs/src/en/rbac_management/rbac_management.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To access the RBAC Management page, click **RBAC Management** in the **Admin Set
1717
The Role List page displays all roles in a table format. You can filter, search, and sort roles using the controls at the top of the page.
1818

1919
- **Status filter**: A segmented control to toggle between **Active** and **Inactive** roles. Active is selected by default.
20-
- **Name search**: A property filter to search roles by name or filter by source (System or Custom).
20+
- **Name search**: A property filter to search roles by name or filter by source (System or Custom). The filter input adapts to the selected property — for example, the **Source** filter exposes the available values (System / Custom) as a typed selector rather than a free-form text box, while the **Name** filter accepts free text.
2121
- **Create Role**: A button to create a new custom role.
2222

2323
The table displays the following columns:
@@ -165,21 +165,28 @@ Here are some common permission configurations to help you understand how the fo
165165
1. Open the role detail drawer and select the **Permissions** tab
166166
2. Click the **Add Permission** button
167167
3. In the modal, fill in the following fields:
168-
- **Scope Type / Target**: Select one of the scope entries that were assigned to the role. The dropdown lists only scopes that have at least one actionable entity.
169-
- **Permission Type**: Select the entity type. Only valid types for the selected scope type are shown.
168+
- **Scope Type / Target**: Select one of the scope entries that were assigned to the role. The dropdown lists only scopes that have at least one actionable entity. The target is shown by its resolved, localized name (for example, the domain or project's display name) rather than its raw UUID, so you can recognize the scope at a glance.
169+
- **Permission Type**: Select the entity type. Only valid types for the selected scope type are shown. Permission type labels (such as **Role Assignment**) are localized to match your UI language.
170170
- **Permission**: Select the operation (e.g., Create, Read, Update, Soft Delete, Hard Delete, or delegation operations)
171171
4. Click **Add** to create the permission
172172

173-
![](../images/rbac_add_permission_modal.png)
173+
![](../images/rbac_permission_modal.png)
174+
<!-- TODO: Recapture screenshot of the Add Permission modal showing the resolved, localized scope target name and localized Permission Type labels (replaces rbac_add_permission_modal.png) -->
175+
176+
:::note
177+
The filter controls in the permissions list now use input types tailored to each filter property — selectors for enumerated values (such as Permission Type, Permission), and free text for name-style fields — making it faster to narrow the list to the entries you care about.
178+
:::
174179

175180
:::note
176181
If a role was created without any scopes (for example, a legacy role imported from an earlier version), the **Add Permission** modal falls back to showing separate **Scope Type** and **Target** fields so that administrators can still configure the permission target.
177182
:::
178183

179-
### Delete a Permission
184+
### Remove a Permission
180185

181-
1. In the **Permissions** tab, click the **Delete** button next to the permission you want to remove
182-
2. Confirm the deletion in the confirmation dialog
186+
1. In the **Permissions** tab, click the **Remove Permission** button next to the permission you want to remove
187+
2. A small confirmation popup appears anchored to the button. Click **OK** to confirm, or **Cancel** to dismiss.
188+
189+
Removing a permission from a role only detaches it from the role's permission set — the role itself, its scopes, and its user assignments are kept. You can add the same permission back later from the same tab, so this action is treated as reversible and uses a lightweight popup confirmation rather than a typed-name confirmation modal.
183190

184191
## Manage User Assignments
185192

@@ -197,9 +204,12 @@ The **Role Assignments** tab in the role detail drawer shows which users are ass
197204

198205
![](../images/rbac_add_user_modal.png)
199206

200-
### Remove Users from a Role
207+
### Revoke Users from a Role
208+
209+
1. In the **Role Assignments** tab, click the **Revoke User** button next to the user you want to remove
210+
2. A small confirmation popup appears anchored to the button. Click **OK** to revoke the assignment, or **Cancel** to dismiss.
201211

202-
1. In the **Role Assignments** tab, click the **Delete** button next to the user you want to remove
203-
2. Confirm the removal in the confirmation dialog
212+
![](../images/rbac_revoke_popconfirm.png)
213+
<!-- TODO: Capture screenshot of the Popconfirm-style revoke confirmation anchored to the Revoke User button -->
204214

205-
![](../images/rbac_remove_user_dialog.png)
215+
Revoking a user removes only that user's assignment to this role; the role itself and its other assignments are kept, and the user can be added back from **Add User** at any time. Because the action is reversible, it uses a lightweight popup confirmation rather than a typed-name confirmation modal.

packages/backend.ai-webui-docs/src/ja/rbac_management/rbac_management.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ RBAC管理ページにアクセスするには、サイドバーメニューの*
1717
ロール一覧ページでは、すべてのロールがテーブル形式で表示されます。ページ上部のコントロールを使用して、ロールのフィルタリング、検索、ソートができます。
1818

1919
- **ステータスフィルター**: **アクティブ****非アクティブ**のロールを切り替えるセグメントコントロールです。デフォルトではアクティブが選択されています。
20-
- **名前検索**: 名前でロールを検索したり、ソース(システムまたはカスタム)でフィルタリングできるプロパティフィルターです。
20+
- **名前検索**: 名前でロールを検索したり、ソース(システムまたはカスタム)でフィルタリングできるプロパティフィルターです。フィルター入力は選択したプロパティに合わせて切り替わります。例えば **ソース** フィルターは利用可能な値(システム / カスタム)を選択式の入力として表示し、**名前** フィルターは自由入力のテキストボックスを表示します。
2121
- **ロールを作成**: 新しいカスタムロールを作成するボタンです。
2222

2323
テーブルには以下の列が表示されます:
@@ -165,12 +165,17 @@ RBAC管理ページにアクセスするには、サイドバーメニューの*
165165
1. ロール詳細パネルを開き、**権限**タブを選択します
166166
2. **権限を追加**ボタンをクリックします
167167
3. モーダルで以下のフィールドを入力します:
168-
- **スコープタイプ / 対象**: ロールに割り当てられたスコープエントリの1つを選択します。ドロップダウンには、操作可能なエンティティが少なくとも1つ存在するスコープのみが表示されます。
169-
- **権限タイプ**: エンティティタイプを選択します。選択したスコープタイプに有効なタイプのみ表示されます。
168+
- **スコープタイプ / 対象**: ロールに割り当てられたスコープエントリの1つを選択します。ドロップダウンには、操作可能なエンティティが少なくとも1つ存在するスコープのみが表示されます。対象は生のUUIDではなく、解決済みのローカライズ表示名(ドメインやプロジェクトの表示名など)で表示されるため、どのスコープか一目で確認できます。
169+
- **権限タイプ**: エンティティタイプを選択します。選択したスコープタイプに有効なタイプのみ表示されます。権限タイプのラベル(例: **ロール割り当て**)もUIの言語に合わせてローカライズされます。
170170
- **権限**: 操作を選択します(例: 作成、読み取り、更新、削除、完全削除、または委任操作)
171171
4. **追加**をクリックして権限を作成します
172172

173-
![](../images/rbac_add_permission_modal.png)
173+
![](../images/rbac_permission_modal.png)
174+
<!-- TODO: 解決済みのスコープ対象名とローカライズされた権限タイプラベルが表示された権限追加モーダルのスクリーンショットを撮り直します(rbac_add_permission_modal.png を置き換え)。 -->
175+
176+
:::note
177+
権限一覧のフィルターコントロールは、各フィルタープロパティに合わせた入力タイプを使うようになりました。列挙値(権限タイプ、権限など)にはセレクター、名前形式のフィールドには自由入力のテキストが提供され、目的のエントリを素早く絞り込めます。
178+
:::
174179

175180
:::note
176181
スコープなしで作成されたロール(例: 以前のバージョンからインポートされたレガシーロール)の場合、**権限を追加**モーダルには**スコープタイプ****対象**のフィールドがそれぞれ表示され、管理者が権限の対象を直接設定できます。
@@ -179,7 +184,9 @@ RBAC管理ページにアクセスするには、サイドバーメニューの*
179184
### 権限の削除
180185

181186
1. **権限**タブで、削除する権限の横にある**権限を削除**ボタンをクリックします
182-
2. 確認ダイアログで削除を確認します
187+
2. ボタンに連動した小さな確認ポップアップが表示されます。**OK**をクリックして削除するか、**キャンセル**で閉じます。
188+
189+
ロールから権限を削除しても、ロール自体・スコープ・ユーザー割り当ては保持され、ロールの権限セットから切り離されるだけです。同じ権限はこのタブから後で再度追加できるため、この操作は元に戻せる操作として扱われ、名前を入力して確認するモーダルではなく軽量なポップアップ確認を使用します。
183190

184191
## ユーザー割り当ての管理
185192

@@ -197,9 +204,12 @@ RBAC管理ページにアクセスするには、サイドバーメニューの*
197204

198205
![](../images/rbac_add_user_modal.png)
199206

200-
### ロールからユーザーを削除
207+
### ロールからユーザーを解除
208+
209+
1. **ロール割り当て**タブで、解除するユーザーの横にある**ユーザー解除**ボタンをクリックします
210+
2. ボタンに連動した小さな確認ポップアップが表示されます。**OK**をクリックして割り当てを解除するか、**キャンセル**で閉じます。
201211

202-
1. **ロール割り当て**タブで、削除するユーザーの横にある**ユーザーを削除**ボタンをクリックします
203-
2. 確認ダイアログで削除を確認します
212+
![](../images/rbac_revoke_popconfirm.png)
213+
<!-- TODO: ユーザー解除ボタンに連動したポップアップ形式の解除確認のスクリーンショットを撮影します。 -->
204214

205-
![](../images/rbac_remove_user_dialog.png)
215+
ユーザーを解除すると、そのユーザーのこのロールへの割り当てだけが取り除かれ、ロール自体や他の割り当ては保持されます。**ユーザーを追加**から同じユーザーをいつでも追加し直せます。この操作は元に戻せるため、名前を入力して確認するモーダルではなく軽量なポップアップ確認を使用します。

0 commit comments

Comments
 (0)