Documentation

Welcome to Retool! We're a fast way to build custom internal software.

You'll find the 5 minute demo, quickstart guide, and documentation for each of our connectors and components here. If you've got any questions -- chat with us on the bottom right!

Get Started    Guides

User permissions

Learn how to control how much access users have to your Retool apps and resources.

As an admin of Retool you can use Permission Groups to control which users have access to which apps and resources. See Inviting users and authentication to learn how to invite users to Retool.

If you can't see Settings > Permissions you are not an admin and will not be able to perform the tasks described in this guide.

Figure 1. **Settings** > **Permissions**.

Figure 1. Settings > Permissions.

Default groups

All Retool user accounts are added to the All Users group when first created. By default this group has editor permissions (explained below) on all apps. Additionally, by default this group can write queries against all resources when editing an app. You can edit the permissions of the All Users group so that users don't have edit permissions on all apps and query write permissions on all resources when invited.

Retool also provides the following non-editable default groups:

  • An viewer can use all apps.
  • An editor can use and edit all apps and can write queries against all resources when editing an app.
  • An admin can use all apps, edit them, write queries against all resources, invite users, and change user permissions. The first user who signs up for Retool is an admin by default.

When using the on-premise version of Retool, an admin must invite users. Anyone who signs in without an invite is assigned no permissions by default. See On-premise.

When using the cloud version of Retool, anyone who signs in is assigned as a viewer by default. See Cloud.e

Create a group

  1. Open Settings > Permissions.
  2. Click Create New Group.
  3. Give the new group a name.
Figure 2. Creating a new group called `QA`.

Figure 2. Creating a new group called QA.

  1. Click Create.
  2. Click the row containing your new group in order to select it. The Group Details section shows more information about your new group.
  3. Use Group Details > Apps to control how much access the group has to each app.
Figure 3. Using **Group Details** > **Apps** to specify that the `auditor` group should have `own` access to `Sample GSheets App`, `edit` access to `Sample Users Page`, and `use` access to `Onboarding Page`.

Figure 3. Using Group Details > Apps to specify that the auditor group should have own access to Sample GSheets App, edit access to Sample Users Page, and use access to Onboarding Page.

  1. Use Group Details > Resources to control which resources the group can write queries agains when an app is in edit mode.
Figure 4. Using **Group Details** > **Resources** to specify that the `auditor` group should be able to write queries against the `onboarding_db (edit)` resource.

Figure 4. Using Group Details > Resources to specify that the auditor group should be able to write queries against the onboarding_db (edit) resource.

  1. Click Save to confirm your changes.

Edit a single user's groups

  1. Open Settings > Users.
  2. Click the user whose groups you want to edit. Retool highlights the user's row to indicate that it's selected. The User Details pane shows more information about that particular user.
Figure 5. Viewing the **User Details** for the `Sales Guy` user.

Figure 5. Viewing the User Details for the Sales Guy user.

  1. Use the Permissions Groups text box to edit the user's groups.

Edit which users belong to a group

  1. Open Settings > Permissions.
  2. Click the group that you want to edit. Retool highlight's the row blue to indicate that it's selected. The Group Details pane shows more information about that particular group.
Figure 6. Viewing the **Group Details** for the `editor` group.

Figure 6. Viewing the Group Details for the editor group.

  1. Enable the checkbox next to a user's name in Groups Details > Users to add that user to that group. Disable the checkbox to remove that user from that group.

Add users to a group during invitation

When inviting users to Retool, click Add Group and then specify which groups they belong to in the Groups to add invited members to text box.

Figure 7. Adding `alice@tryretool.com` to the `QA` group when inviting her.

Figure 7. Adding alice@tryretool.com to the QA group when inviting her.

User permissions


Learn how to control how much access users have to your Retool apps and resources.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.