diff options
| author | Frederic Guillot <fred@kanboard.net> | 2016-01-22 21:23:12 -0500 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2016-01-22 21:23:12 -0500 |
| commit | ad8fcf035ab92d8cd06179959000b9a1681b1505 (patch) | |
| tree | 80f4e35b16c1c1a6d4c473983bc6cb62b9519494 /doc/api-application-procedures.markdown | |
| parent | f27bcec2d92af83ee7205c84954cda9d7b2fc55d (diff) | |
Add new API procedures for groups, roles and project permissions
Diffstat (limited to 'doc/api-application-procedures.markdown')
| -rw-r--r-- | doc/api-application-procedures.markdown | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/api-application-procedures.markdown b/doc/api-application-procedures.markdown index ab1230cc..2897b526 100644 --- a/doc/api-application-procedures.markdown +++ b/doc/api-application-procedures.markdown @@ -229,3 +229,63 @@ Response example: } } ``` + +### getApplicationRoles + +- Purpose: **Get the application roles** +- Parameters: none +- Result: **Dictionary of role => role_name** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getApplicationRoles", + "id": 317154243 +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 317154243, + "result": { + "app-admin": "Administrator", + "app-manager": "Manager", + "app-user": "User" + } +} +``` + +### getProjectRoles + +- Purpose: **Get the project roles** +- Parameters: none +- Result: **Dictionary of role => role_name** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getProjectRoles", + "id": 8981960 +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 8981960, + "result": { + "project-manager": "Project Manager", + "project-member": "Project Member", + "project-viewer": "Project Viewer" + } +} +```
\ No newline at end of file |