Skip to content

Commit 1fe682a

Browse files
feat(docs): document role Assignees view in GAC (#3031)
## Description Document the role **Assignees** view in GAC: Assignees column counts, **Permissions** | **Assignees** tabs, _Direct_ / _via group_ sources, filters, search, and **Default Role for All Users** behavior. Update related GAC, user management, and troubleshooting pages to point at the **Assignees** view and the **Permissions** tab layout. No URL changes; no new redirects required. ## Pull request type - [ ] Review Fixes - [ ] Documentation Overhaul - [x] Feature/Story - appsmithorg/appsmith-ee#9407 (implements appsmithorg/appsmith-ee#8726) - [ ] A-Force - [ ] Error in documentation - [ ] Maintenance ## Documentation tickets ## Checklist From the below options, select the ones that are applicable: - [ ] Checked for Grammarly suggestions. - [x] Adhered to the writing checklist. - [x] Adhered to the media checklist. - [x] Verified and updated cross-references or added redirect rules. - [x] Tested the redirect rules on deploy preview. - [x] Validated the modifications made to the content on the deploy preview. - [ ] Validated the CSS modifications on different screen sizes. --------- Co-authored-by: Luis Ibarra <98054342+sebastianiv21@users.noreply.github.com>
1 parent 7d33127 commit 1fe682a

14 files changed

Lines changed: 81 additions & 13 deletions

File tree

.github/styles/config/vocabularies/technical/accept.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,4 +153,6 @@ AWS ECS EC2
153153
Droplet
154154
Enable webhook trigger
155155
Validation
156-
Issuer
156+
Issuer
157+
Assignees
158+
SCIM

website/docs/advanced-concepts/granular-access-control/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Granular Access Control (GAC) in Appsmith allows you to specify precise access p
3131
## Core components
3232

3333
* **Permissions** - define the actions users can perform on specific resources. In Appsmith, each resource, whether an app, page, workflow, datasource, environment, or query, can have detailed permissions for actions such as create, read, update, and delete.
34-
* **Roles** - are sets of permissions bundled together that can be assigned to users or user groups. They provide varying levels of access to Appsmith resources.
34+
* **Roles** - are sets of permissions bundled together that can be assigned to users or user groups. They provide varying levels of access to Appsmith resources. On the Roles screen, you can review who has each role from the [Assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees) view.
3535
* **Users** - Individual users who need access to the Appsmith instance.
3636
* **User Groups** - Collections of users that allow you to assign roles to multiple users simultaneously. Users in a group inherit the roles assigned to that group.
3737

website/docs/advanced-concepts/granular-access-control/how-to-guides/configure-default-permissions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Follow these steps to configure permissions:
4444
<ZoomImage src="/img/GAC-Default-Roles-toggle.png" alt="Toggle the Default roles options to view Default Roles" caption="Toggle the Default roles options to view Default Roles"
4545
/>
4646

47-
4. Click the _Default Role For All Users_ that opens a configuration screen.
48-
5. Based on your permission needs, provide access to resources. For example, if you want to provide read-only access to an application so that all authenticated users can view it, assign permissions as below:
47+
4. Click **Default Role For All Users** to open the role page.
48+
5. On the **Permissions** tab, provide access to resources based on your needs. The **Assignees** tab shows **Assigned to all users** because every user in the instance inherits this role. For example, if you want to provide read-only access to an application so that all authenticated users can view it, assign permissions as below:
4949

5050
<Tabs queryString="gac-resource">
5151
<TabItem label="Application Resources" value="application-resources">

website/docs/advanced-concepts/granular-access-control/reference/custom-roles.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Appsmith allows the creation of custom roles to manage granular access control,
2828

2929
## Create custom role
3030

31-
To create a custom role, click the **Add role** button on the Roles screen. On the roles configuration screen, assign permissions to resources in each tab based on your business needs.
31+
To create a custom role, click the **Add role** button on the Roles screen. On the role page, open the **Permissions** tab and assign permissions to resources in each resource tab based on your business needs. Use the **Assignees** tab to review which users currently have the role. For more information, see [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees).
3232

3333
<ZoomImage
3434
src="/img/GAC-Create-Custom-Roles-Add-Role-button.png"
@@ -106,7 +106,7 @@ To restrict access to specific pages within an Appsmith application, modify the
106106

107107
### Give app access
108108

109-
To give access to specific applications within an Appsmith workspace, configure the permissions at the application level for the custom role. When creating a new custom role, it's necessary to also configure permissions for the datasources and environments used by the application. After configuring these permissions, assign the custom role to the necessary users or groups to grant them the required access.
109+
To give access to specific applications within an Appsmith workspace, configure the permissions at the application level for the custom role under the **Permissions** tab. When creating a new custom role, it's necessary to also configure permissions for the datasources and environments used by the application. After configuring these permissions, assign the custom role to the necessary users or groups to grant them the required access. You can confirm the assignment on the role's **Assignees** tab.
110110

111111
Example permissions setup to provide read-only access:
112112

@@ -287,3 +287,4 @@ Example permissions setup to provide read-only access:
287287

288288
* [Restrict Query Access](/advanced-concepts/granular-access-control/how-to-guides/restrict-query-access)
289289
* [Permissions](/advanced-concepts/granular-access-control/reference/permissions)
290+
* [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees)

website/docs/advanced-concepts/granular-access-control/reference/default-roles.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ Despite having extensive permissions, the Organization Administrator role in App
121121

122122
## Default Role for All Users
123123

124-
Default Roles for All users helps you in assigning some default permissions to all users across your Appsmith instance. Initially, the role has [permission to create workspace](/advanced-concepts/granular-access-control/reference/permissions?gac-resource=create-others). For all other permissions, Instance administrators can fully customize this role according to your business needs. For more information, see [How to provide default access to all users](/advanced-concepts/granular-access-control/how-to-guides/configure-default-permissions) guide.
124+
Default Role for All Users helps you assign some default permissions to all users across your Appsmith instance. Initially, the role has [permission to create workspace](/advanced-concepts/granular-access-control/reference/permissions?gac-resource=create-others). For all other permissions, instance administrators can fully customize this role according to your business needs. For more information, see [How to provide default access to all users](/advanced-concepts/granular-access-control/how-to-guides/configure-default-permissions).
125+
126+
On the Roles screen, the **Assignees** column shows **All users** for this role. On the role page, the **Assignees** tab shows **Assigned to all users** instead of listing individual users, because membership is implicit for every user in the instance. Configure permissions on the **Permissions** tab. For more information about viewing assignees on other roles, see [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees).
125127

126128
## Administrator Role for Workspace
127129

website/docs/advanced-concepts/granular-access-control/roles.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,65 @@ Custom roles in Appsmith allow users to define specific permission sets tailored
7070
alt="Click the Add role button to create a custom role"
7171
caption="Click the Add role button to create a custom role"
7272
/>
73+
74+
## View role assignees
75+
76+
The Roles screen shows how each role is assigned. The **Assignees** column lists direct assignment counts as `N users · M groups`. For the [Default Role for All Users](/advanced-concepts/granular-access-control/reference/default-roles#default-role-for-all-users), the column shows **All users** instead of numeric counts, because every user in the instance inherits that role.
77+
78+
<ZoomImage
79+
src="/img/GAC-Roles-Assignees-column.png"
80+
alt="Assignees column on the Roles screen showing user and group counts"
81+
caption="Assignees column on the Roles screen"
82+
/>
83+
84+
To review who has a role:
85+
86+
1. Go to **Admin Settings** > **Roles**.
87+
2. Open the role.
88+
3. Select the **Assignees** tab. Use the **Permissions** tab to configure the role's permission tree.
89+
90+
<ZoomImage
91+
src="/img/GAC-Role-Assignees-tab.png"
92+
alt="Assignees tab on a role showing users with Direct and via group sources"
93+
caption="Assignees tab on a role"
94+
/>
95+
96+
The **Assignees** tab is view-only. It lists users who have the role either directly or through a group. To assign or unassign a role, use the [Users](/getting-started/setup/instance-configuration/user-management#users) or [Groups](/getting-started/setup/instance-configuration/user-management#groups) pages.
97+
98+
### Assignee sources
99+
100+
Each user row shows the assignment source:
101+
102+
* **Direct**: You assigned the role to the user.
103+
* **via group name**: You assigned the role to a group that includes the user. The group name links to that group's settings page.
104+
105+
A user can show both sources when you assign the role directly and through one or more groups. Users provisioned through System for Cross-domain Identity Management (SCIM) show a provisioned indicator next to their username. For more information, see [User Provisioning & Group Sync](/advanced-concepts/user-provisioning-group-sync).
106+
107+
### Filter and search assignees
108+
109+
Use the filter control on the **Assignees** tab to narrow the list:
110+
111+
| Filter | Shows |
112+
| --- | --- |
113+
| **All** | Users with the role from any source |
114+
| **Direct** | Users assigned the role directly |
115+
| **Via group** | Users who inherit the role through a group |
116+
117+
Use the search field on the role page to find assignees by username. Scroll the list to load more results when a role has many assignees.
118+
119+
### Default Role for All Users
120+
121+
For the **Default Role for All Users**, the **Assignees** tab shows **Assigned to all users** instead of an enumerated list. Membership is implicit for every user in the instance. Configure the permissions for this role on the **Permissions** tab. For more information, see [Configure Default Access to Apps](/advanced-concepts/granular-access-control/how-to-guides/configure-default-permissions).
122+
123+
<ZoomImage
124+
src="/img/GAC-Default-Role-Assignees-all-users.png"
125+
alt="Assignees tab for Default Role For All Users showing Assigned to all users"
126+
caption="Assignees tab for Default Role For All Users"
127+
/>
128+
129+
## See also
130+
131+
* [Custom Roles](/advanced-concepts/granular-access-control/reference/custom-roles)
132+
* [Default Roles](/advanced-concepts/granular-access-control/reference/default-roles)
133+
* [Permissions](/advanced-concepts/granular-access-control/reference/permissions)
134+
* [User Management](/getting-started/setup/instance-configuration/user-management)

website/docs/getting-started/setup/instance-configuration/user-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Users are individuals who have access to your Appsmith instance. From the Users
136136
Administrators can:
137137

138138
- Invite new users.
139-
- Assign or update user roles (e.g., Viewer, Developer, Admin).
139+
- Assign or update user roles (for example, Viewer, Developer, Admin).
140140
- Add users to specific groups.
141141
- Deactivate or remove users from the instance.
142142

@@ -152,7 +152,7 @@ Groups allow administrators to organize users into logical collections for easie
152152
<dd>
153153
With the Groups feature, administrators can:
154154

155-
- Create and name groups based on roles (e.g., “Developers”, “Support Team”, “Finance”)
155+
- Create and name groups based on roles (for example, “Developers”, “Support Team”, “Finance”)
156156
- Add or remove users from specific groups
157157
- Assign roles (such as Viewer, Editor, Administrator) to the entire group
158158

@@ -168,7 +168,7 @@ Roles define what actions a user or group is allowed to perform within your Apps
168168

169169
<dd>
170170

171-
Roles can be assigned to individual users or to groups, making it easier to manage access consistently and securely across your organization.
171+
Roles can be assigned to individual users or to groups, making it easier to manage access consistently and securely across your organization. To see who already has a role, open the role on the Roles page and select the **Assignees** tab. For more information, see [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees).
172172

173173
Appsmith supports two types of roles:
174174

website/docs/help-and-support/troubleshooting-guide/gac-errors.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ A custom role that provides access to the application is created, but users are
5959

6060
#### Solution
6161

62-
* Verify if the custom role access is provided by checking the groups and role mapping or user and role assignment. If not, add users to groups that have access or assign roles to the appropriate users.
63-
* Ensure you have granted the necessary access to the datasources used by the application under the _Datasources & Environments_ tab when configuring the custom role. For more details on permissions, see [Permissions](/advanced-concepts/granular-access-control/reference/permissions).
62+
* Verify if the custom role access is provided by checking the groups and role mapping or user and role assignment. You can also open the role under **Admin Settings > Roles**, select the **Assignees** tab, and confirm whether the user appears as a **Direct** assignee or **via** a group. If not, add users to groups that have access or assign roles to the appropriate users.
63+
* Ensure you have granted the necessary access to the datasources used by the application under the _Datasources & Environments_ tab when configuring the custom role. For more details on permissions, see [Permissions](/advanced-concepts/granular-access-control/reference/permissions). For more details on reviewing assignees, see [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees).
6464

6565
## Getting help
6666

website/docs/help-and-support/troubleshooting-guide/user-management-errors.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The user still has a default role (such as **App Viewer**) assigned in addition
2727
#### Solution
2828

2929
- Go to **Admin Settings > Users** and review every role assigned to the user, not just the custom role.
30+
- Open the custom role under **Admin Settings > Roles**, select the **Assignees** tab, and confirm how the user receives the role (**Direct** or **via** a group). For more information, see [View role assignees](/advanced-concepts/granular-access-control/roles#view-role-assignees).
3031
- Remove the broad default role (for example, App Viewer) from the user, and rely on the custom role with **View** permission for only the intended pages.
3132
- Ensure the **View** permission is also enabled at the application level, not only at the page level.
3233
- For more details on building roles, see [Custom Roles](/advanced-concepts/granular-access-control/reference/custom-roles) and [Permissions](/advanced-concepts/granular-access-control/reference/permissions).
@@ -40,7 +41,7 @@ After accepting an invite and logging in, the user lands on an empty home screen
4041
#### Solution
4142

4243
- Ask an instance administrator to review the user's current configuration under **Admin Settings > Users**.
43-
- Confirm the role granting access is actually assigned and that **View** is enabled at the application level.
44+
- Confirm the role granting access is actually assigned and that **View** is enabled at the application level. You can also open that role under **Admin Settings > Roles** and check the **Assignees** tab.
4445
- If the issue persists, collect the backend server logs covering the time range when the access was configured (`docker logs <container>` for Docker, or `kubectl logs <pod>` for Kubernetes) and share them with support for further investigation.
4546

4647
### Permission denied on query execute despite a working role
-33 KB
Loading

0 commit comments

Comments
 (0)