diff options
author | Steve Norman <steve.norman@thomsonreuters.com> | 2015-04-28 19:02:44 +0300 |
---|---|---|
committer | Steve Norman <steve.norman@thomsonreuters.com> | 2015-07-03 14:17:57 +0300 |
commit | b3a751112ded889769dadc7cc69d2d1467aa9471 (patch) | |
tree | cc9f635e07f0ad0b74ae1d5b45b14f1eeebed236 /doc/api/users.md | |
parent | 49749169e9b442c13cdc279d7e783f65a3afc794 (diff) |
Allow user to be blocked and unblocked via the API
Diffstat (limited to 'doc/api/users.md')
-rw-r--r-- | doc/api/users.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 8b04282f160..5dca77b5c7b 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -396,3 +396,31 @@ Parameters: - `id` (required) - SSH key ID Will return `200 OK` on success, or `404 Not found` if either user or key cannot be found. + +## Block user + +Blocks the specified user. Available only for admin. + +``` +PUT /users/:uid/block +``` + +Parameters: + +- `uid` (required) - id of specified user + +Will return `200 OK` on success, or `404 User Not Found` is user cannot be found. + +## Unblock user + +Unblocks the specified user. Available only for admin. + +``` +PUT /users/:uid/unblock +``` + +Parameters: + +- `uid` (required) - id of specified user + +Will return `200 OK` on success, or `404 User Not Found` is user cannot be found. |