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-group-member-procedures.markdown | |
| parent | f27bcec2d92af83ee7205c84954cda9d7b2fc55d (diff) | |
Add new API procedures for groups, roles and project permissions
Diffstat (limited to 'doc/api-group-member-procedures.markdown')
| -rw-r--r-- | doc/api-group-member-procedures.markdown | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/doc/api-group-member-procedures.markdown b/doc/api-group-member-procedures.markdown new file mode 100644 index 00000000..54153537 --- /dev/null +++ b/doc/api-group-member-procedures.markdown @@ -0,0 +1,152 @@ +Group Member API Procedures +=========================== + +### getGroupMembers + +- Purpose: **Get all members of a group** +- Parameters: + - **group_id** (integer, required) +- Result on success: **List of users** +- Result on failure: **false** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getGroupMembers", + "id": 1987176726, + "params": [ + "1" + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1987176726, + "result": [ + { + "group_id": "1", + "user_id": "1", + "id": "1", + "username": "admin", + "is_ldap_user": "0", + "name": null, + "email": null, + "notifications_enabled": "0", + "timezone": null, + "language": null, + "disable_login_form": "0", + "notifications_filter": "4", + "nb_failed_login": "0", + "lock_expiration_date": "0", + "is_project_admin": "0", + "gitlab_id": null, + "role": "app-admin" + } + ] +} +``` + +### addGroupMember + +- Purpose: **Add a user to a group** +- Parameters: + - **group_id** (integer, required) + - **user_id** (integer, required) +- Result on success: **true** +- Result on failure: **false** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "addGroupMember", + "id": 1589058273, + "params": [ + 1, + 1 + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1589058273, + "result": true +} +``` + +### removeGroupMember + +- Purpose: **Remove a user from a group** +- Parameters: + - **group_id** (integer, required) + - **user_id** (integer, required) +- Result on success: **true** +- Result on failure: **false** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "removeGroupMember", + "id": 1730416406, + "params": [ + 1, + 1 + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1730416406, + "result": true +} +``` + +### isGroupMember + +- Purpose: **Check if a user is member of a group** +- Parameters: + - **group_id** (integer, required) + - **user_id** (integer, required) +- Result on success: **true** +- Result on failure: **false** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "isGroupMember", + "id": 1052800865, + "params": [ + 1, + 1 + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1052800865, + "result": false +} +``` |