View Source

Class FilterUserFilterController

Inheritance

System.Object

ManagementApiControllerBase

UserOrCurrentUserControllerBase

UserFilterControllerBase

Namespace: Umbraco.Cms.Api.Management.Controllers.User.Filter

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class FilterUserFilterController : UserFilterControllerBase

Constructors

FilterUserFilterController(IUserService, IBackOfficeSecurityAccessor, IUserPresentationFactory)

Declaration

public FilterUserFilterController(IUserService userService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IUserPresentationFactory userPresentationFactory)

Parameters

Type	Name	Description
IUserService	userService
IBackOfficeSecurityAccessor	backOfficeSecurityAccessor
IUserPresentationFactory	userPresentationFactory

Methods

Filter(CancellationToken, Int32, Int32, UserOrder, Direction, Nullable<HashSet<Guid>>, Nullable<HashSet<UserState>>, String)

Query users

Declaration

public async Task<IActionResult> Filter(CancellationToken cancellationToken, int skip = 0, int take = 100, UserOrder orderBy = null, Direction orderDirection = null, HashSet<Guid>? userGroupIds = null, HashSet<UserState>? userStates = null, string filter = "")

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.Int32	skip	Amount to skip.
System.Int32	take	Amount to take.
UserOrder	orderBy	Property to order by.
Direction	orderDirection	Direction to order in.
System.Nullable<HashSet<Guid>>	userGroupIds	Keys of the user groups to include in the result.
System.Nullable<HashSet<UserState>>	userStates	User states to include in the result.
System.String	filter	A string that must be present in the users name or username.

Returns

Type	Description
Task<IActionResult>	A paged result of the users matching the query.