john-okeefe
31fae3cea8
- Update User Max Devices - Complete API documentation - Update User Max Devices - Success test case - Update User Max Devices - Invalid Zero test case - Update User Max Devices - Exceeds Maximum test case - Update User Max Devices - Missing ID test case - Include validation rules and example payloads - Document all status codes and error responses
96 lines
1.7 KiB
Plaintext
96 lines
1.7 KiB
Plaintext
meta {
|
|
name: Update User Max Devices
|
|
type: http
|
|
seq: 6
|
|
}
|
|
|
|
put {
|
|
url: {{base_url}}/api/auth/users/{{user_id}}/max-devices
|
|
body: {
|
|
max_devices: {{max_devices}}
|
|
}
|
|
auth: inherit
|
|
}
|
|
|
|
settings {
|
|
encodeUrl: true
|
|
timeout: 0
|
|
}
|
|
|
|
docs {
|
|
## Update User Max Devices (Admin)
|
|
|
|
Updates the maximum number of devices a user can register.
|
|
|
|
**Method:** PUT
|
|
|
|
**Endpoint:** /api/auth/users/:id/max-devices
|
|
|
|
**Authentication:** Required (Admin only)
|
|
|
|
**URL Parameters:**
|
|
- `id` (string): User ID (UUID)
|
|
|
|
**Request Body:**
|
|
```json
|
|
{
|
|
"max_devices": 10
|
|
}
|
|
```
|
|
- `max_devices` (integer, required): Maximum devices (1-100)
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"message": "max devices updated"
|
|
}
|
|
```
|
|
|
|
**Status Codes:**
|
|
- 200: Success
|
|
- 400: Invalid request (missing id, invalid max_devices, out of range)
|
|
- 401: Unauthorized
|
|
- 403: Forbidden (admin access required)
|
|
- 500: Internal server error
|
|
|
|
**Validation:**
|
|
- `max_devices` must be between 1 and 100
|
|
- User ID must be a valid UUID
|
|
- User must exist
|
|
|
|
**Features:**
|
|
- Admin-only endpoint for managing user device quotas
|
|
- Allows per-user device limits (default: 10)
|
|
- Prevents excessive device registrations per user
|
|
- Useful for multi-tenant or managed deployments
|
|
|
|
**Examples:**
|
|
|
|
Set max devices to 5:
|
|
```json
|
|
{
|
|
"max_devices": 5
|
|
}
|
|
```
|
|
|
|
Set max devices to 50 (premium user):
|
|
```json
|
|
{
|
|
"max_devices": 50
|
|
}
|
|
```
|
|
|
|
Set max devices to 1 (restricted user):
|
|
```json
|
|
{
|
|
"max_devices": 1
|
|
}
|
|
```
|
|
|
|
**Use Cases:**
|
|
- Restrict free-tier users to 5 devices
|
|
- Allow premium users up to 100 devices
|
|
- Reduce device cap for suspicious accounts
|
|
- Implement tiered device limits per user plan
|
|
}
|