Services/Sync/Server/Archived/0.3/API/Admin: Difference between revisions
Jump to navigation
Jump to search
(New page: = Weave 0.3 Admin API = Release Date: TBD = API Specification = The Admin API may be used to create users, update passwords, and delete users. It is a post API, and the path is a single-...) |
|||
| Line 12: | Line 12: | ||
|- valign="top" | |- valign="top" | ||
| function | | function | ||
| [create|update|delete] | | <nowiki>[create|update|delete]</nowiki> | ||
|- valign="top" | |- valign="top" | ||
| username | | username | ||
Revision as of 23:34, 22 October 2008
Weave 0.3 Admin API
Release Date: TBD
API Specification
The Admin API may be used to create users, update passwords, and delete users. It is a post API, and the path is a single-endpoint, so it takes no path arguments. Parameters that may be posted to the service:
| Parameter | Description |
| function | [create|update|delete] |
| username | The username to be operated on. |
| password | Required if creating a user or changing the password |
| secret | The secret, if one has been required by WEAVE_USER_ADMIN_SECRET |
Response Codes
200 OK -- Returned on a successful request.
400 Bad Request -- Will be returned if there was an error in the client's request, such as a non-POST URL, a nonexistent function, or a missing secret.
404 Not Found -- Returned if the user does not exist and was expected to.
503 Service Unavailable -- An internal error (storage failure). Please try back again later.