Class UserController

Namespace: Identity.API.Controllers
Assembly: Identity.API.dll

Controller that manage users.

[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]s")]
public sealed class UserController : ControllerBase

Inheritance

object ← ControllerBase ← UserController

Inherited Members

Constructors

UserController\(IMediator\)

Users controller constructor, injecting IMediator to send requests.

public UserController(IMediator mediator)

Parameters

mediator IMediator

Methods

ChangePassword\(Guid, ChangePasswordCommand\)

Change the password of a User.

[HttpPut("{userGuid}/password")]
[ProducesResponseType(typeof(PasswordChangedDto), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(500)]
public Task<ActionResult<PasswordChangedDto>> ChangePassword(Guid userGuid, ChangePasswordCommand command)

Parameters

userGuid Guid

ID of the User.

command ChangePasswordCommand

Body of the request that contains current and new password.

Returns

Task < ActionResult <PasswordChangedDto\>\>

CreateUser\(CreateUserCommand\)

Creates a new User.

[HttpPost]
[ProducesResponseType(typeof(UserResponse), 201)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(409)]
[ProducesResponseType(500)]
public Task<ActionResult<User>> CreateUser(CreateUserCommand command)

Parameters

command CreateUserCommand

The user infos to create.

Returns

Task < ActionResult <User\>\>

DeleteUser\(Guid\)

Deletes a User.

[HttpDelete("{userGuid}")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
public Task<ActionResult<Unit>> DeleteUser(Guid userGuid)

Parameters

userGuid Guid

The unique identifier of the user to delete.

Returns

Task < ActionResult <Unit\>\>

GetAllUsers\(\)

Gets a list of all Users.

[HttpGet]
[Authorize(Roles = "Admin")]
[ProducesResponseType(typeof(IEnumerable<UserResponse>), 200)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(500)]
public Task<ActionResult<IEnumerable<UserResponse>>> GetAllUsers()

Returns

Task < ActionResult < IEnumerable <UserResponse\>\>\>

GetAllUsersByRestaurantId\(Guid\)

Gets a list of all Users by their RestaurantId.

[HttpGet("restaurants/{restaurantGuid}/users")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(IEnumerable<UserResponse>), 200)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(500)]
public Task<ActionResult<IEnumerable<UserResponse>>> GetAllUsersByRestaurantId(Guid restaurantGuid)

Parameters

restaurantGuid Guid

Returns

Task < ActionResult < IEnumerable <UserResponse\>\>\>

GetUserById\(Guid\)

Gets a specific User by their unique identifier.

[HttpGet("{userGuid}")]
[ProducesResponseType(typeof(UserResponse), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<User>> GetUserById(Guid userGuid)

Parameters

userGuid Guid

The unique identifier for the user.

Returns

Task < ActionResult <User\>\>

PasswordReset\(UserResetPasswordCommand\)

Verify password reset token validity and reset password.

[HttpPost("password-reset")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Unit>> PasswordReset(UserResetPasswordCommand command)

Parameters

command UserResetPasswordCommand

Body of the request that contains user's reset token.

Returns

Task < ActionResult <Unit\>\>

PasswordResetRequest\(UserResetPasswordInquiryCommand\)

Send an email to a user to reset his password.

[HttpPost("password-reset-request")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(404)]
[ProducesResponseType(408)]
[ProducesResponseType(500)]
[ProducesResponseType(503)]
public Task<ActionResult<Unit>> PasswordResetRequest(UserResetPasswordInquiryCommand command)

Parameters

command UserResetPasswordInquiryCommand

Body of the request that contains user's email.

Returns

Task < ActionResult <Unit\>\>

PasswordResetTokenValidation\(UserVerifyResetTokenCommand\)

Verify password reset token validity.

[HttpPost("validate-password-token")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Unit>> PasswordResetTokenValidation(UserVerifyResetTokenCommand command)

Parameters

command UserVerifyResetTokenCommand

Body of the request that contains user's reset token.

Returns

Task < ActionResult <Unit\>\>

ReorderProducts\(ReorderStaffsCommand\)

Update users by bulk to change their order.

[HttpPut("reorder")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(User), 204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Unit>> ReorderProducts(ReorderStaffsCommand command)

Parameters

command ReorderStaffsCommand

Dictionary that contain Guid and SortingIndex of the Users.

Returns

Task < ActionResult <Unit\>\>

The updated user.

UpdateUser\(Guid, UpdateUserCommand\)

Updates an existing User.

[HttpPut("{userGuid}")]
[ProducesResponseType(typeof(User), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(409)]
[ProducesResponseType(500)]
public Task<ActionResult<User>> UpdateUser(Guid userGuid, UpdateUserCommand command)

Parameters

userGuid Guid

The unique identifier of the user to update.

command UpdateUserCommand

The updates to apply to the user.

Returns

Task < ActionResult <User\>\>

Last modified: 21 May 2024