Avatar
Documentation Team
  • Updated
Follow

Elvis 6 action plug-ins setting - requiredRoles

The requiredRoles setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Elvis 6 Action plug-ins - configuration settings.

Required No
Description

Required capabilities for the plugin to become visible. One or more capabilities can be configured, both standard capabilities and custom capabilities.

Custom capabilities always start with ROLE_CUSTOM_ACTION_ followed by the name of your capability, for example ROLE_CUSTOM_ACTION_MYACTION. Custom capabilities can be assigned in the "Manage Permissions" tab.
Basic setting 
<action>
    <requiredRoles>...</requiredRoles>
</action>

Examples

Standard download capability

<requiredRoles>
    <role>ROLE_DOWNLOAD</role>
</requiredRoles>

Custom plugin capability

<requiredRoles>
    <role>ROLE_CUSTOM_ACTION_MYACTION</role>
</requiredRoles>

Standard and custom capability

<requiredRoles>
    <role>ROLE_IMPORT</role>
    <role>ROLE_CUSTOM_ACTION_MYACTION</role>
</requiredRoles>

Comments

0 comments

Please sign in to leave a comment.

In this article

      Tags:

    Other articles in this section

    See more

    Related articles