Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Rehaul Granular Access Control Docs #2255

Open
wants to merge 108 commits into
base: main
Choose a base branch
from
Open

Conversation

jnikhila
Copy link
Collaborator

@jnikhila jnikhila commented May 9, 2024

Description

Provide a concise summary of the changes made in this pull request

Pull request type

Check the appropriate box:

  • Review Fixes
  • Documentation Overhaul
  • Feature/Story
    • Link one or more Engineering Tickets
      *
  • A-Force
  • Error in documentation
  • Maintenance

Documentation tickets

Link to one or more documentation tickets:

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

- Initial structural changes to sidebar
- Concept doc - Default Role
- Reference - Instance Administrator Role
- Broken link fixes
Copy link

vercel bot commented May 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
appsmith-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 7, 2024 1:03pm

@jnikhila jnikhila marked this pull request as ready for review June 7, 2024 06:08

## Core components

* **Permissions** - define what actions a user can perform on specific resources. Every resource in Appsmith whether it’s an app, a page, a workflow, a datasource and environment, or a query can have granular permissions set for actions like create, read, update, and delete.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a datasource and environment, or a query : This sounds odd. datasource, environment or query sounds better. Any reason to try and link datasource and environment together?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In one of the user tests it came up that datasources and environment tab is there, so that should be intuitive for users to connect the dot.


Despite having extensive permissions, the Instance Administrator role in Appsmith cannot perform the following tasks:

- Inability to access or update individual workspaces or app content. This means that Instance Administrators cannot view or edit the specific content within each workspace or app, such as queries, datasources, or their configurations.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instance administrator though has permission to assign any role to itself or to any user. This means that if the instance admin does need to take over an individual workspace, they can assign the default workspace role to themselves or to any other user to get access.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving it here in case we want to add this as a caveat or a way to unblock the user if thats what they are looking for.

</thead>
<tbody>
<tr>
<td>Workspace</td>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting doesn't exist in Application Resources page.

<tr>
<td>Application</td>
<td>NA</td>
<td>Allows running queries for the given application.</td>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. Execute permission is only available at query level in Application Resources page.

Copy link

@trishaanand trishaanand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partial review done for these files.


## Make Public permission

The **Make Public** permission permits users to change the access level of resources, making them available to the public. When the **Make Public** permission is assigned to a workspace or an application, it, along with the automatically assigned permissions, are inherited by the child resources. Once granted, users can enable the **Make application public** option on the _Invite Users_ modal to make an application publicly available. This option allows external users to access the app without the need to log in to Appsmith.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **Make Public** permission permits users to change the access level of resources, making them available to the public. When the **Make Public** permission is assigned to a workspace or an application, it, along with the automatically assigned permissions, are inherited by the child resources. Once granted, users can enable the **Make application public** option on the _Invite Users_ modal to make an application publicly available. This option allows external users to access the app without the need to log in to Appsmith.
The **Make Public** permission permits users to change the access level of applications, making them available to the public. When the **Make Public** permission is assigned to a workspace or an application, it, along with the automatically assigned permissions, are inherited by the child resources. Once granted, users can enable the **Make application public** option on the _Invite Users_ modal to make an application publicly available. This option allows external users to access the app without the need to log in to Appsmith.


## Invite User permission

The **Invite User** permission permits users to invite other users to Appsmith workspace or applications and provides access to the resources within workspace.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Invite user is only applicable to a Group. This permission does not exist for any other resource.


## Remove User permission

The **Remove User** permission permits users to remove other users from the resources in Appsmith.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Permission only applicable in a User Group and no other resource.


## Associate Role permission

The **Associate Role** permission permits users to assign or change roles of other users in Appsmith.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kinda confused about the structuring of this. Associate role is a permission given on a particular role. If the user has this permission for a role, the user would be able to assign this particular role to any user or a group.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants