Table of Contents

Class UsersController

Namespace
OpenSettings.AspNetCore.Controllers.v1
Assembly
OpenSettings.AspNetCore.dll
[Route("v1/users")]
public class UsersController : ControllerBase
Inheritance
UsersController
Inherited Members

Constructors

UsersController(IUserService)

public UsersController(IUserService userService)

Parameters

userService IUserService

Methods

CreateUser(CreateUserRequest, CancellationToken)

[HttpPost]
public Task<IActionResult> CreateUser(CreateUserRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateUserRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

DeleteUser(DeleteUserRequest, CancellationToken)

[HttpDelete("{UserId}")]
public Task<IActionResult> DeleteUser(DeleteUserRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteUserRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetPaginatedUsers(GetPaginatedRequest, CancellationToken)

[HttpGet("paginated")]
public Task<IActionResult> GetPaginatedUsers(GetPaginatedRequest request, CancellationToken cancellationToken = default)

Parameters

request GetPaginatedRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetUserById(GetUserRequest, CancellationToken)

[HttpGet("{UserIdOrSlug}")]
public Task<IActionResult> GetUserById(GetUserRequest request, CancellationToken cancellationToken = default)

Parameters

request GetUserRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetUserBySlug(GetUserRequest, CancellationToken)

[HttpGet("slug/{UserIdOrSlug}")]
public Task<IActionResult> GetUserBySlug(GetUserRequest request, CancellationToken cancellationToken = default)

Parameters

request GetUserRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

UpdateUser(UpdateUserRequest, CancellationToken)

[HttpPut("{UserId}")]
public Task<IActionResult> UpdateUser(UpdateUserRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateUserRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>