Roles and Permissions

This documentation is for Dash Enterprise.
Dash Enterprise is the fastest way to write & deploy Dash apps and
Jupyter notebooks.
10% of the Fortune 500 uses Dash Enterprise to productionize AI and
data science apps. Find out if your company is using Dash Enterprise.

This page applies to Dash Enterprise 5.

What users can do in Dash Enterprise is determined by:

About Admin Actions and the admin Role

The admin role that administrators can assign in Keycloak grants access to the Admin section of Dash Enterprise.

This Admin section contains some settings that administrators can configure directly in Dash Enterprise, as well as links to other services intended for administrators:

These services have separate authentication and require different credentials than what you use to log in to Dash Enterprise as an administrator.

The credentials were obtained by the administrator who performed your Dash Enterprise installation and stored according to your organization’s best practices. Keycloak and the Keycloak IdP setup wizard both use
one set of credentials, and the KOTS Admin Console uses a different set.

We sometimes refer to actions performed in Keycloak and the KOTS Admin Console as administrator-only, but they do not rely on the Dash Enterprise admin role like other actions detailed in Permissions below.

Assigning Roles

You can assign roles to users in Keycloak. If you’re unfamiliar with Keycloak, make sure you’ve read Using Keycloak.

The viewer role is assigned to all users by default, so you only need to assign licensed_user and admin roles. Assign licensed_user to members of your organization
who need license seats, and admin to those who administer Dash Enterprise.

For help determining the roles your users need or troubleshooting user-reported permission issues, see Permissions below.

Roles for Dash Enterprise are considered Client Roles in Keycloak. The role mappings for a new user look like:

<img>

The Assigned Roles and Effective Roles represent the roles that a user has. In the example above, no roles have been assigned to the user yet, so the user only has the default viewer role
as an effective role.

Roles that you assign directly to a user become assigned roles, and roles that a user obtains through group membership become effective roles. You can’t directly remove effective roles from users in
their role mappings—instead, remove the user from the group or change the group’s role mappings.

User roles appear in the Dash Enterprise Users menu.

<img>

This list displays the same role information you see in Keycloak when selecting a user’s role mappings, but can be more convenient when you want to see multiple users’ roles at a glance.

If a user hasn’t logged in to Dash Enterprise yet, their role information is not available in Dash Enterprise. Go to Keycloak to see the user’s roles.

Assigning a Role to a Single User

To assign a role to a single user:

  1. Go to Keycloak at https://auth-&lt;your-dash-enterprise-server&gt;.
  2. Go to Users.
  3. Find the user you want to assign a role to. You may need to select View all users to display the full list of users.
  4. Select the user; then go to Role Mappings.
  5. In Client Roles, select dash.
  6. In Available Roles, select the role you want to assign; then select Add selected. The user now has the role as an assigned role.
  7. (Recommended) Log the user out of Dash Enterprise:
  8. Go to Sessions.
  9. Select Log out all sessions.

Role changes take effect the next time the user logs in to Dash Enterprise.

Important: Be careful when making role changes to users with the licensed_user role. If you remove the licensed_user role from a user who owns or co-owns apps in Dash Enterprise,
they will lose ownership of those apps. Learn more about app ownership in License Seats.

Assigning a Role to a Group

You can assign a role to all the members of a group at once by mapping the group to the role.

If you don’t have any groups yet, create groups natively in Keycloak or
map groups from your identity provider.

To map a group to a role:

  1. Go to Keycloak at https://auth-&lt;your-dash-enterprise-server&gt;.
  2. Go to Groups.
  3. Select the group you want to map; then select Edit.
  4. Go to Role Mappings.
  5. In Client Roles, select dash.
  6. In Available Roles, select the role you want to map; then select Add selected. All group members now have the role as an effective role.
  7. (Recommended) Log the group members out of Dash Enterprise:
  8. Go to Users.
  9. For each group member, select the user; then go to Sessions and select Log out all sessions.

Role changes take effect the next time the group members log in to Dash Enterprise.

Important: Be careful when making membership or role changes to groups mapped to the licensed_user role. If you remove the licensed_user role from a member of the group who owns or co-owns apps in Dash Enterprise
(by removing the user from the group or removing the role mapping from the group), they will lose ownership of those apps. Learn more about app ownership in