User API Roadmap
Planned user create/update/disable/enable/reset workflows that should not be treated as live until routes are published.
Planned user create/update/disable/enable/reset workflows that should not be treated as live until routes are published.
Coverage
| Item | Status |
|---|---|
| POST /api/v1/users.php | Use deployed route documentation |
| GET /api/v1/users/{id} | Use deployed route documentation |
| PATCH /api/v1/users/{id} | Use deployed route documentation |
| POST /api/v1/users/{id}/disable | Use deployed route documentation |
| POST /api/v1/users/{id}/enable | Use deployed route documentation |
| POST /api/v1/users/{id}/reset-access | Use deployed route documentation |
Workflow
- Confirm each route against the deployed route documentation.
- Test with a staging token first.
- Use read endpoints to inspect current state before any write operation.
- Record the external workflow ID in your own system.
- Review jobs, request logs, and audit logs after the workflow runs.
Notes
- Do not create production automation around undocumented routes.
- Use idempotency keys for write endpoints.
- Keep rollback steps documented with the integration runbook.
Diagram
flowchart TD
A[External System] --> B[Read Current State]
B --> C{Expected State?}
C -- No --> D[Stop and Alert]
C -- Yes --> E[Run Approved Workflow]
E --> F[Read Jobs and Logs]
F --> G[Operator Review]