HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Hide or control access to customized components

Describes how to manage access to customized components in the Optimizely Content Management System (CMS) user interface.

The AllowedRoles property for a component definitions lets you control the groups that are allowed to view and select a certain component. You can hide a component completely by setting the AllowedRoles property to none, or setting it to a null string which prevents an access check.

The following example shows how to hide or show a certain component, depending on a global setting.

[Component]
        public class FileManagementComponent : ComponentDefinitionBase
        {
            public FileManagementComponent() : base("epi-cms.component.FileManagement")
            {
                Categories = new string[]{"cms"};
                LanguagePath = "/episerver/cms/components/filemanagement";
                SortOrder = 200;
                PlugInAreas = new string[] { PlugInArea.DefaultAssetsGroup };
    
                AllowedRoles.Clear();
                AllowedRoles.Add("none");
            }
        }