Roles in FusionAuth are associated with an application. You can define as many roles as you want in an application. There are no limits on the number of roles a user or a group can have.
Roles are application specific and may be specific to the domain of the application. Roles are typically used by APIs and applications to control access to functionality. For example, Zendesk presents a different user interface to users with the
agent role than to users without that role.
For a further example, an e-commerce application may have the following roles:
On the other hand, a content management system may have these roles:
Roles are available in the JWT upon successful authorization and are also returned as part of the user’s registrations.
You can associate roles with users directly via their registration. Or you can assign an application role to a group, and then any users in that group who have access to that application will have that role.
Core Concepts Relationships
Below is a visual reminder of the relationships between FusionAuth’s primary core concepts.
Roles in FusionAuth have the following attributes:
The name of the role. This value should be short and descriptive. Roles can only be created and deleted, only the role description may be modified.
One or more roles may be marked as default. A default role will be automatically added to new user registrations when no roles are explicitly provided on the API request.
A role may be optionally marked as a super user role. This indicator is just a marker to indicate to you that this role encompasses all other roles. It has no effect on the usage of the role.
An optional description to better describe the intended use of this role.
FusionAuth Application Roles
FusionAuth provides an administrative user interface for the running instance with several built-in roles. These can be assigned to any user registered with the FusionAuth admin application. These roles control access to functionality within the FusionAuth administrative user interface.
These roles are used only internally to manage authorization within the FusionAuth administrative user interface application.
These roles are not global and are not present in any other applications for which FusionAuth provides authentication, authorization, or user management.
Below you can see the administrative user interface screen where you assign roles in the FusionAuth application to a user.
Role Schema and Exceptions
The below table outlines how roles were designed at an abstract level. Of course, risk is always relative to the information and organization; even a low-access role can do significant damage in the wrong hands.
FusionAuth roles suffix meanings
|low||Can view entities of a particular type|
|high||Can add or edit the entities|
|high||Can delete entities.|
FusionAuth special roles
|highest||Can manage anything (see below)|
|varied||Tech support role (see below)|
Below are all the roles available in FusionAuth. Please note the additional explainer for the
user_support_manager following this table.
FusionAuth application roles
|Can manage everything, including creating new users with administrator privileges.|
|Can add and edit IP access control lists. Available since 1.30.0.|
|Can delete IP access control lists. Available since 1.30.0.|
|Can add and edit API keys.|
|Can delete applications.|
|Can add and edit applications.|
|Can view audit logs.|
|Can delete Connectors. Available since 1.18.0.|
|Can add and edit Connectors. Available since 1.18.0.|
|Can delete consents.|
|Can add and edit consents.|
|Can add and edit email templates.|
|Can add and edit entities. Available since 1.26.0.|
|Can view the event log.|
|Can delete forms and form fields. Available since 1.18.0.|
|Can add and edit forms and form fields. Available since 1.18.0.|
|Can delete groups.|
|Can add and edit groups.|
|Can add and edit keys.|
|Can add and edit lambdas.|
|Can delete message templates. Available since 1.26.0.|
|Can add and edit message templates. Available since 1.26.0.|
|Can delete messengers. Available since 1.26.0.|
|Can add and edit messengers. Available since 1.26.0.|
|Can add and edit reactor settings. Available since 1.15.0.|
|Can view reports.|
|Can add and edit system configuration.|
|Can delete tenants.|
|Can add and edit tenants.|
|Can add and edit themes.|
|Can delete user actions.|
|Can add and edit user actions.|
|Can delete users.|
|Can add and edit users.|
|Allows for a limited scope of user management. See below. Available since 1.23.0.|
|Can view user information. Available since 1.23.0.|
|Can add or edit webhooks.|
Special Role - user_support_manager
user_support_manager role is a role tuned for tier 1 technical support personnel and has a mix of capabilities. A user with such a role can:
|Send a verify email request.|
|passwords||Send a forgot password request.|
|passwords||Require a password change at next login.|
|group||Manage group membership.|
|family||Manage family membership.|
|registration||View a registration.|
|registration||Add a registration with no role management. If a new registration is created it would receive the default roles only. Cannot add a role to the FusionAuth admin UI application.|
|registration||Edit a registration with no role modification.|
|registration||Delete a registration.|
|user||Add a user.|
|user||Edit a user, except for any identity information that could be used to authenticate. For example, the email and username cannot be modified.|
|user||Lock a user account.|
|user||Unlock a user account.|
|user||Modify 2FA settings if available.|
|user||Action a user.|
|user||Add a comment to a user.|
|user||Verify a user’s email address.|
|tokens||Manage sessions (refresh tokens).|