diff options
| author | Frédéric Guillot <fred@kanboard.net> | 2014-09-17 15:43:04 +0200 |
|---|---|---|
| committer | Frédéric Guillot <fred@kanboard.net> | 2014-09-17 15:43:04 +0200 |
| commit | f7bea1a1ef699664dd9e0d3f5a49d8cfa122e6c4 (patch) | |
| tree | 63a6295add7542b6ec6f0b321888edd20e0b14cb /docs/api-json-rpc.markdown | |
| parent | 243e72474bd0c87b8647efe1edeb1116a0a5fcd0 (diff) | |
Improve API calls for project permissions
Diffstat (limited to 'docs/api-json-rpc.markdown')
| -rw-r--r-- | docs/api-json-rpc.markdown | 65 |
1 files changed, 55 insertions, 10 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index 61ea9d85..efb13d7c 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -424,7 +424,7 @@ Request example: Response example: ```json - +{ "jsonrpc": "2.0", "id": 942472945, "result": true @@ -434,58 +434,103 @@ Response example: ### getAllowedUsers - Purpose: **Get allowed users for a given project** -- Parameters: **project_id** (integer) +- Note: Only people explicitly allowed are part of this list, administrators are always authorized +- Parameters: + - **project_id** (integer, required) - Result on success: Key/value pair of user_id and username - Result on failure: **false** Request example: ```json - +{ + "jsonrpc": "2.0", + "method": "getAllowedUsers", + "id": 1944388643, + "params": [ + 1 + ] +} ``` Response example: ```json - +{ + "jsonrpc": "2.0", + "id": 1944388643, + "result": { + "1": "user1", + "2": "user2", + "3": "user3" + } +} ``` ### revokeUser - Purpose: **Revoke user access for a given project** -- Parameters: **project_id** (integer), **user_id** (integer) +- Parameters: + - **project_id** (integer, required) + - **user_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json - +{ + "jsonrpc": "2.0", + "method": "revokeUser", + "id": 251218350, + "params": [ + 1, + 2 + ] +} ``` Response example: ```json - +{ + "jsonrpc": "2.0", + "id": 251218350, + "result": true +} ``` ### allowUser - Purpose: **Grant user access for a given project** -- Parameters: **project_id** (integer), **user_id** (integer) +- Parameters: + - **project_id** (integer, required) + - **user_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json - +{ + "jsonrpc": "2.0", + "method": "allowUser", + "id": 2111451404, + "params": [ + 1, + 2 + ] +} ``` Response example: ```json - +{ + "jsonrpc": "2.0", + "id": 2111451404, + "result": true +} ``` |