[FEAT]: Admin - User Deactivation: Implement API Endpoint for user deactivation for admin

[dmendie]

Description

Create an API endpoint to deactivate a registered user's account for the admin user. This endpoint will be part of the administration user management. Admin users can deactivate a user using this endpoint

Acceptance Criteria

• The endpoint should be accessible at PUT /api/v1/admin/users/{id}.
• The endpoint should accept HTTP PUT requests with payload.
• The endpoint should deactivate a registered user's account by setting their status to deactivated from the database using the provided user's ID.
• The endpoint should return a 200 OK status code with the updated user's details in the response body
• This endpoint should be secured and only accessible to an admin user

GET /api/v1/admin/users/3454
Payload
To deactivate a user, the appropriate account status should be sent as payload to the endpoint

{
   "status": "deactivate"
}

Response:
On a successful retrieval of the user details, the API should return a 200 OK status code. The response body should contain the user details:

{
"status": "success",
"status_code": 200
"data": {
"id": 3454,
"first_name": "string",
"last_name": "string",
"email": "string",
"avatar_url": "string",
"phone_number': 'string",
"status': 'deactivated",
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-06-01T12:00:00Z"
}
}

Validation:

If the user's ID is missing or invalid, the API should return a 400 Bad Request status code with appropriate validation error messages:

{
  "status": "unsuccessful",
 "status_code": 400,
  "message": "Valid user ID must be provided"
}

If the user does not exist, the API should return a 404 Not Found status code with an appropriate message:

{
  "status": "unsuccessful",
 "status_code": 404,
  "message": "user not found"
}

Purpose

To provide admin users with a way to deactivate a registered user's account

Requirements

• Develop server-side logic to retrieve user's details by ID.
• Securely handle the retrieval process and comply with security standards.
• Ensure the user's ID is validated and handled correctly.

Expected Outcome

API endpoint should allow admin users to deactivate a user's account by ID with appropriate validation and security measures.

Tasks:

• Define the PUT /api/v1/admin/users/{id} route in the server-side application.
• Validate that the user's ID is provided and is in a valid format.
• Implement logic to deactivate the user's account from the database using the provided user ID.
• Return the updated user details in the response body if the ID is valid and the user exists.
• Handle cases where the user's ID is invalid or the user does not exist, providing appropriate error messages.

Testing

• Write unit tests to validate input validation and user deactivation logic.
• Write integration tests to ensure end-to-end functionality.
• Perform security testing to ensure data protection and compliance.