Documentation Index
Fetch the complete documentation index at: https://docs.parchmenthealth.io/llms.txt
Use this file to discover all available pages before exploring further.
Integration Notes
- What Happens: The user access si restored, allowing them to sign in again.
- Use role defaults to
member
- Authorization: Requires
update:user scope.
- Idempotent: If the user is already enabled, the endpoint returns 200 with a message indicating the user is already enabled.
Request
No request body is required. Simply send a PUT request to the endpoint with the organization and user IDs in the path.
PUT /v1/organizations/{organizationId}/users/{userId}/enable
Response
Success Response (200 OK)
{
"success": true,
"statusCode": 200,
"message": "User enabled successfully",
"data": {
"user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
},
"timestamp": "2024-01-15T10:30:00.000Z",
"requestId": "req_1705312200000_abc123"
}
Already Enabled (200 OK)
{
"success": true,
"statusCode": 200,
"message": "User is already enabled",
"data": {
"user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
},
"timestamp": "2024-01-15T10:30:00.000Z",
"requestId": "req_1705312200000_abc123"
}
Response Fields
Success Response Data
| Field | Type | Description |
|---|
user_id | string | Parchment’s unique user identifier |
Common Response Fields
All responses include these standard fields:
| Field | Type | Description |
|---|
success | boolean | Indicates if the request was successful |
statusCode | number | HTTP status code |
timestamp | string | ISO 8601 timestamp of the response |
requestId | string | Unique identifier for debugging |
Status Codes
| Code | Status | Description |
|---|
200 | OK | User successfully enabled (or already enabled) |
401 | Unauthorized | Authentication required or token invalid |
403 | Forbidden | Insufficient permissions (missing update:user scope) |
404 | Not Found | User not found |
500 | Internal Server Error | Unexpected server error |
