docs: update API documentation for consolidated user management
Add documentation for delete_user and reset_user_password endpoints. Update update_profile to reflect consolidated endpoint. Remove obsolete documentation for individual update operations. Add profile guide for end-users. Update API_CONSOLIDATION_PLAN.md with implementation status.
This commit is contained in:
@@ -1,35 +1,71 @@
|
||||
# Change Password
|
||||
|
||||
Change the current user's password.
|
||||
Change user password. Supports both self-service and admin modes.
|
||||
|
||||
**Endpoints**:
|
||||
- Self-service: `PUT /api/auth/password`
|
||||
- Admin reset: `PUT /api/auth/password/:id`
|
||||
|
||||
**Endpoint**: `PUT /api/auth/password`
|
||||
**Auth**: Required
|
||||
**Content-Type**: `application/json`
|
||||
|
||||
## Request Body
|
||||
## Self-Service Mode
|
||||
|
||||
Users can change their own password by providing current password verification.
|
||||
|
||||
### Request Body
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|--------|------|-----------|-------------|
|
||||
| current_password | string | Yes | Current password |
|
||||
| new_password | string | Yes | New password (min 8 chars) |
|
||||
| current_password | string | Yes | Current password for verification |
|
||||
| new_password | string | Yes | New password (min 8 chars, complexity required) |
|
||||
| confirm_password | string | Yes | Must match new_password |
|
||||
|
||||
### Example Request
|
||||
|
||||
```json
|
||||
{
|
||||
"current_password": "oldPassword",
|
||||
"new_password": "NewSecureP@ss123!"
|
||||
"current_password": "OldPassword123!",
|
||||
"new_password": "NewSecureP@ss123!",
|
||||
"confirm_password": "NewSecureP@ss123!"
|
||||
}
|
||||
```
|
||||
|
||||
## Response (204 No Content)
|
||||
## Admin Mode
|
||||
|
||||
Password changed successfully.
|
||||
Admins can reset any user's password without knowing the current password.
|
||||
|
||||
**URL Parameter**: `:id` - Target user's UUID
|
||||
|
||||
### Request Body (Admin Mode)
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|--------|------|-----------|-------------|
|
||||
| new_password | string | Yes | New password (min 8 chars, complexity required) |
|
||||
| confirm_password | string | Yes | Must match new_password |
|
||||
|
||||
### Example Admin Request
|
||||
|
||||
```json
|
||||
{
|
||||
"new_password": "NewSecureP@ss123!",
|
||||
"confirm_password": "NewSecureP@ss123!"
|
||||
}
|
||||
```
|
||||
|
||||
## Response (200 OK)
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "password updated"
|
||||
}
|
||||
```
|
||||
|
||||
## Error Responses
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 400 | Invalid input or weak password |
|
||||
| 401 | Current password is incorrect |
|
||||
| 401 | Invalid or expired token |
|
||||
| 400 | Invalid input, weak password, or passwords don't match |
|
||||
| 401 | Current password is incorrect (self-service mode) |
|
||||
| 403 | Admin access required (admin mode only) |
|
||||
| 404 | User not found (admin mode only) |
|
||||
|
||||
Reference in New Issue
Block a user