Skip to content
Return to top
On this page

# Roles #

> Roles are essentially a bundle of pre-configured access permissions which you can (re)assign to any number of users.

Learn More

To configure roles programmatically, see our API documentation on roles.

## View a Role #

To view an existing role, navigate to Settings > Roles & Permissions > [Role]. Now you can see the role's permissions and other details.

## Create a Role #

To create a role, follow these steps.

1. Navigate to Settings > Roles & Permissions.
2. Click add in the page header.
3. Enter a unique Role Name.
4. Toggle App Access and Admin Access as desired.
   To learn more, see configure role details.
5. Click Save to confirm.

TIP

Next, you will likely need to configure the role's details and configure the role's permissions.

## Configure Role Details #

In addition to defining permissions, roles come with a number of other configuration options. To configure a role's details, follow these steps.

1. Navigate to Settings > Roles & Permissions > [Role].
2. Configure the following options as desired:
   - Permissions — Configures access permissions for the role.
   - Role Name — Sets the name of the role.
   - Role Icon — Sets icon used when referencing this role.
   - Description — Adds a note to help explain the role's purpose.
   - App Access — Auto-configures minimum permissions required to log in to the App.
   - Admin Access — Auto-configures full permissions to project data and Settings. Must be toggled off to restore ability to restrict permissions.
   - IP Access — Adds IP addresses to allow list. Type IP in and hit `Enter` (PC) or `return` (Mac) to confirm. Leave empty to allow all IP addresses.
   - Require MFA — Forces all users within this role to use multi-factor authentication.
   - Users in Role — Lists all users within this role.
3. Click check in the page header to confirm.

App Access vs Admin Access

Roles with App Access enabled are created with the minimum permissions required to login to the app and access their own profile information. Roles that have neither Admin nor App Access enabled are created with public permissions. You can always reconfigure permissions later.

## Delete a Role #

To delete a role, follow these steps.

1. Navigate to Settings > Roles & Permissions > [Role].
2. Click delete in the page header and a popup will appear.
3. Click Delete to confirm.

Users in a Deleted Role

If you delete a role that still has users in it, those users will be given a `NULL` role, which limits them to public permissions. However, you can always assign them a new role.

Built-in Roles

Directus does not allow you to delete the built-in public role or administrator role. To learn more, please see the introductory section on Directus Roles.