# DHIS2 User API

**Canonical:** https://apis.io/apis/dhis2/dhis2-user-api/  
**Provider:** DHIS2 — https://apis.io/providers/dhis2/  
**Base URL:** https://academy.dhis2.org/api  
**Documentation:** https://developers.dhis2.org

DHIS2 User API is one of 48 APIs that [DHIS2](https://apis.io/providers/dhis2/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

The user API from DHIS2 — 38 operation(s) for user.

## Operations (47)

| Method | Path | Summary |
|---|---|---|
| GET | `/user/v1/account/password_reset/` | User v1 account password reset list |
| POST | `/user/v1/account/password_reset/token/validate/` | User v1 account password reset token validate create |
| GET | `/user/v1/account/registration/` | User v1 account registration list |
| POST | `/user/v1/account/registration/` | Create the user's account |
| GET | `/user/v1/accounts` | User v1 accounts list |
| POST | `/user/v1/accounts/cancel_retirement/` | POST /api/user/v1/accounts/cancel_retirement/ |
| POST | `/user/v1/accounts/deactivate_logout/` | POST /api/user/v1/accounts/deactivate_logout/ |
| POST | `/user/v1/accounts/name_change/` | POST /api/user/v1/accounts/name_change/ |
| POST | `/user/v1/accounts/name_change/{username}/confirm/` | POST /api/user/v1/account/name_change/{username}/confirm |
| POST | `/user/v1/accounts/replace_usernames/` | User v1 accounts replace usernames create |
| POST | `/user/v1/accounts/retire/` | POST /api/user/v1/accounts/retire/ |
| POST | `/user/v1/accounts/retire_misc/` | POST /api/user/v1/accounts/retire_misc/ |
| POST | `/user/v1/accounts/retirement_cleanup/` | POST /api/user/v1/accounts/retirement_cleanup/ |
| POST | `/user/v1/accounts/retirement_partner_report/` | POST /api/user/v1/accounts/retirement_partner_report/ |
| PUT | `/user/v1/accounts/retirement_partner_report/` | PUT /api/user/v1/accounts/retirement_partner_report/ |
| POST | `/user/v1/accounts/retirement_partner_report_cleanup/` | POST /api/user/v1/accounts/retirement_partner_report_cleanup/ |
| GET | `/user/v1/accounts/retirement_queue/` | GET /api/user/v1/accounts/retirement_queue/ {'cool_off_days': 7, 'states'… |
| GET | `/user/v1/accounts/retirements_by_status_and_date/` | GET /api/user/v1/accounts/retirements_by_status_and_date/… |
| POST | `/user/v1/accounts/search_emails` | User v1 accounts search emails |
| PATCH | `/user/v1/accounts/update_retirement_status/` | PATCH /api/user/v1/accounts/update_retirement_status/ |
| GET | `/user/v1/accounts/{username}` | User v1 accounts read |
| PATCH | `/user/v1/accounts/{username}` | PATCH /api/user/v1/accounts/{username}/ |
| POST | `/user/v1/accounts/{username}/deactivate/` | POST /api/user/v1/accounts/{username}/deactivate/ |
| POST | `/user/v1/accounts/{username}/image` | User v1 accounts image create |
| DELETE | `/user/v1/accounts/{username}/image` | User v1 accounts image delete |
| GET | `/user/v1/accounts/{username}/retirement_status/` | User v1 accounts retirement status read |
| GET | `/user/v1/accounts/{username}/verification_status/` | User v1 accounts verification status list |
| GET | `/user/v1/accounts/{username}/verifications/` | User v1 accounts verifications list |
| GET | `/user/v1/forum_roles/{name}/users/` | User v1 forum roles users list |
| GET | `/user/v1/me` | User v1 get |
| POST | `/user/v1/preferences/email_opt_in/` | Post function for updating the email opt in preference |
| GET | `/user/v1/preferences/time_zones/` | **Use Cases** |
| GET | `/user/v1/preferences/{pref_key}/users/` | User v1 preferences users list |
| GET | `/user/v1/preferences/{username}` | User v1 preferences read |
| PATCH | `/user/v1/preferences/{username}` | User v1 preferences partial update |
| GET | `/user/v1/preferences/{username}/{preference_key}` | User v1 preferences read |
| PUT | `/user/v1/preferences/{username}/{preference_key}` | User v1 preferences update |
| DELETE | `/user/v1/preferences/{username}/{preference_key}` | User v1 preferences delete |
| GET | `/user/v1/user_prefs/` | User v1 user prefs list |
| GET | `/user/v1/user_prefs/{id}/` | User v1 user prefs read |
| GET | `/user/v1/users/` | User v1 users list |
| GET | `/user/v1/users/{id}/` | User v1 users read |
| POST | `/user/v1/validation/registration` | POST /api/user/v1/validation/registration/ |
| GET | `/user/v2/account/registration/` | User v2 account registration list |
| POST | `/user/v2/account/registration/` | Create the user's account |
| GET | `/user/{api_version}/account/login_session/` | User account login session list |
| POST | `/user/{api_version}/account/login_session/` | POST /user/{api_version}/account/login_session/ |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/dhis2/openapi/dhis2-user-api-openapi.yml

## Other DHIS2 APIs (12)

- [DHIS2 Agreements API](https://apis.io/apis/dhis2/dhis2-agreements-api/)
- [DHIS2 Api/v1 API](https://apis.io/apis/dhis2/dhis2-api-v1-api/)
- [DHIS2 Api/v2 API](https://apis.io/apis/dhis2/dhis2-api-v2-api/)
- [DHIS2 Bookmarks API](https://apis.io/apis/dhis2/dhis2-bookmarks-api/)
- [DHIS2 Certificates API](https://apis.io/apis/dhis2/dhis2-certificates-api/)
- [DHIS2 Change Email Settings API](https://apis.io/apis/dhis2/dhis2-change-email-settings-api/)
- [DHIS2 Cohorts API](https://apis.io/apis/dhis2/dhis2-cohorts-api/)
- [DHIS2 Commerce API](https://apis.io/apis/dhis2/dhis2-commerce-api/)
- [DHIS2 Completion API](https://apis.io/apis/dhis2/dhis2-completion-api/)
- [DHIS2 Course Experience API](https://apis.io/apis/dhis2/dhis2-course-experience-api/)
- [DHIS2 Course Home API](https://apis.io/apis/dhis2/dhis2-course-home-api/)
- [DHIS2 Course Live API](https://apis.io/apis/dhis2/dhis2-course-live-api/)

## Tags

User

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/dhis2` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/dhis2/dhis2-user-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/dhis2/.
