Support the documentation
This documentation was written by volunteers. Please help support our effort:
A common requirement, especially for larger websites with many editors, is the possibility to selectively control access to certain backend tools and parts of the content. For example so that editors can only edit certain pages or content types or that they are limited to specific workspaces. These access restrictions are used to enforce certain workflows and to reduce complexity for editors.
On this page, we'll first explain the most important concepts; and explain how the default roles can be used.
Then, the biggest part of this chapter is a deep-dive how to create own roles combined with access control lists.
Afterwards, we show some real-world examples.
Frontend Access Restrictions are not covered here
The following diagram explains the most important concepts and their relationships which you need to understand for using the built-in roles:
In the diagram above, we focused on Authorization logic. To get a full understanding about all the parts involved in the Neos and Flow permission system, read the Concept Deep-Dive: Custom Roles chapter.
A User is a real-world person, known to the system. The user has a first name, last name, etc. The user does not contain any authentication logic.
An Account is an authentication method for a user. By default, a user has a single account for backend login; though you can attach multiple accounts to the same user to allow different authentication methods like oAuth, LDAP or proprietary single-signon for a single user.
The account has the account identifier like jon.doe (which is what the user enters together with a password in the login form).
An account references a set of Roles, to which permissions are attached. Which roles are available is configured in source code, in a file called Policy.yaml. These roles are often called Groups in other systems.
Roles can inherit from other roles.
Finally, an Authentication Provider is the component in the system which does the actual authentication work. It is configured in Settings.yaml as part of the source code.
Neos ships with a PersistedUsernamePasswordProvider called Neos.Neos:Backend.
An Account is bound to a specific Authentication Provider. You usually do not need to touch this part if you want to adjust permissions in the Neos backend.