Reads or writes the list of users known to the backend. When editing the user list, the list must be read with a GET and later sent back with a PUT with all fields in each UserProperties record.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/users
Gets a UserList document containing the list of all known users.
Expected Payload: none
Replied Payload: a UserList document containing the list of all known users.
Parameters: none
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a UserList containing the list of all known users. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
PUT /api/v1/users
Send a UserList document containing the list of all known users to the backend. The UserList replaces the previous one. Already logged in users remain logged in, even if they are deleted from the list or if their password was changed.
Expected Payload: The UserList document to write.
Replied Payload: The UserList document echoed back.
Parameters: none
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns the written UserList echoed back. |
| 400 | cannot change the password. Probably the user logged in by LDAP. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |