Users
The Users REST API provides endpoints to access and modify users in Haplo applications.
Enabling the Users API
Install the haplo_api_user_v0
plugin to enable access to the Users API.
Permissions
A user can only access the API if they are in the “API v0: User” group (API code haplo:group:api-v0:user-api
). In general, you should create an API key for the service user defined by the haplo_api_user_v0
plugin:
Your Name » System management » Users » SRV » API v0: User » New API key…
Set the request path to /api/v0-user/
for any API key you create.
Endpoints
Endpoint | Method | Action |
/api/v0-user/id |
GET | Get user |
/api/v0-user/create |
POST | Create user |
/api/v0-user/id |
POST | Update user |
/api/v0-user/enable |
POST | Enable user |
/api/v0-user/group |
GET | Get group |
/api/v0-user/find-by-tag |
GET | Find by tag |
See Introduction for how to form a request URL.