diff options
| author | Boyan Tabakov <boyan.tabakov@futurice.com> | 2012-12-18 23:24:31 +0400 |
|---|---|---|
| committer | Boyan Tabakov <boyan.tabakov@futurice.com> | 2012-12-18 23:24:31 +0400 |
| commit | e954438a1d3a45addebf52ab04155459d7d84db0 (patch) | |
| tree | f88bc4f1aaf560f34fb0f7b106a8e5f3a215ee17 /doc/api/users.md | |
| parent | f4a6f1fd5a9fb9f35bb43956275c5f1da96ce019 (diff) | |
Extended users API to support updating and deleting users.
Also added tests.
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 200c0e06e04..b94d7c0f789 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -20,6 +20,8 @@ GET /users "linkedin": "", "twitter": "", "dark_scheme": false, + "extern_uid": "john.smith", + "provider": "provider_name", "theme_id": 1 }, { @@ -34,6 +36,8 @@ GET /users "linkedin": "", "twitter": "", "dark_scheme": true, + "extern_uid": "jack.smith", + "provider": "provider_name", "theme_id": 1 } ] @@ -64,6 +68,8 @@ Parameters: "linkedin": "", "twitter": "", "dark_scheme": false, + "extern_uid": "john.smith", + "provider": "provider_name", "theme_id": 1 } ``` @@ -84,10 +90,47 @@ Parameters: + `linkedin` - Linkedin + `twitter` - Twitter account + `projects_limit` - Number of projects user can create ++ `extern_uid` - External UID ++ `provider` - External provider name ++ `bio` - User's bio Will return created user with status `201 Created` on success, or `404 Not found` on fail. +## User modification +Modify user. Available only for admin + +``` +PUT /users/:id +``` + +Parameters: ++ `email` - Email ++ `username` - Username ++ `name` - Name ++ `password` - Password ++ `skype` - Skype ID ++ `linkedin` - Linkedin ++ `twitter` - Twitter account ++ `projects_limit` - Limit projects wich user can create ++ `extern_uid` - External UID ++ `provider` - External provider name ++ `bio` - User's bio + + +Will return created user with status `200 OK` on success, or `404 Not +found` on fail. + +## User deletion +Delete user. Available only for admin + +``` +DELETE /users/:id +``` + +Will return deleted user with status `200 OK` on success, or `404 Not +found` on fail. + ## Current user Get currently authenticated user. |