Search Results for

    Show / Hide Table of Contents
    View Source

    Class UserGroupsController

    Inheritance
    System.Object
    Microsoft.AspNetCore.Mvc.ControllerBase
    UmbracoApiControllerBase
    UmbracoApiController
    UmbracoAuthorizedApiController
    UmbracoAuthorizedJsonController
    BackOfficeNotificationsController
    Namespace: Umbraco.Cms.Web.BackOffice.Controllers
    Assembly: Umbraco.Web.BackOffice.dll
    Syntax
    [PluginController("UmbracoApi")]
    [Authorize(Policy = "SectionAccessUsers")]
    [PrefixlessBodyModelValidator]
    public class UserGroupsController : BackOfficeNotificationsController, IUmbracoFeature, IDiscoverable

    Constructors

    View Source

    UserGroupsController(IUserService, IContentService, IEntityService, IMediaService, IBackOfficeSecurityAccessor, IUmbracoMapper, ILocalizedTextService, IShortStringHelper, AppCaches)

    Declaration
    public UserGroupsController(IUserService userService, IContentService contentService, IEntityService entityService, IMediaService mediaService, IBackOfficeSecurityAccessor backofficeSecurityAccessor, IUmbracoMapper umbracoMapper, ILocalizedTextService localizedTextService, IShortStringHelper shortStringHelper, AppCaches appCaches)
    Parameters
    Type Name Description
    IUserService userService
    IContentService contentService
    IEntityService entityService
    IMediaService mediaService
    IBackOfficeSecurityAccessor backofficeSecurityAccessor
    IUmbracoMapper umbracoMapper
    ILocalizedTextService localizedTextService
    IShortStringHelper shortStringHelper
    AppCaches appCaches

    Methods

    View Source

    GetEmptyUserGroup()

    Returns the scaffold for creating a new user group

    Declaration
    public UserGroupDisplay GetEmptyUserGroup()
    Returns
    Type Description
    UserGroupDisplay
    View Source

    GetUserGroup(Int32)

    Return a user group

    Declaration
    [Authorize(Policy = "UserBelongsToUserGroupInRequest")]
    public ActionResult<UserGroupDisplay> GetUserGroup(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<UserGroupDisplay>
    View Source

    GetUserGroups(Boolean)

    Returns all user groups

    Declaration
    public IEnumerable<UserGroupBasic> GetUserGroups(bool onlyCurrentUserGroups = true)
    Parameters
    Type Name Description
    System.Boolean onlyCurrentUserGroups
    Returns
    Type Description
    IEnumerable<UserGroupBasic>
    View Source

    PostDeleteUserGroups(Int32[])

    Declaration
    [HttpPost]
    [HttpDelete]
    [Authorize(Policy = "UserBelongsToUserGroupInRequest")]
    public IActionResult PostDeleteUserGroups([FromQuery] int[] userGroupIds)
    Parameters
    Type Name Description
    System.Int32[] userGroupIds
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.IActionResult
    View Source

    PostSaveUserGroup(UserGroupSave)

    Declaration
    public ActionResult<UserGroupDisplay> PostSaveUserGroup(UserGroupSave userGroupSave)
    Parameters
    Type Name Description
    UserGroupSave userGroupSave
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<UserGroupDisplay>
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • UserGroupsController(IUserService, IContentService, IEntityService, IMediaService, IBackOfficeSecurityAccessor, IUmbracoMapper, ILocalizedTextService, IShortStringHelper, AppCaches)
    • Methods
      • GetEmptyUserGroup()
      • GetUserGroup(Int32)
      • GetUserGroups(Boolean)
      • PostDeleteUserGroups(Int32[])
      • PostSaveUserGroup(UserGroupSave)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX