diff options
author | Izaak Alpert <ialpert@blackberry.com> | 2013-09-04 19:19:03 +0400 |
---|---|---|
committer | Izaak Alpert <ialpert@blackberry.com> | 2013-09-04 21:17:17 +0400 |
commit | 8248e1f2b83895f394a3fecd25dcea4a8b40303b (patch) | |
tree | b863098af85b8dc1d1dbd956799eab2b5058a60a /doc/api/groups.md | |
parent | 626359831402aeede4c4cb12cb10c7534a0dae79 (diff) |
Add group membership api
Change-Id: I5b174bba02856ede788dcb51ec9b0d598ea7d0df
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r-- | doc/api/groups.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index e9702ea2cd1..9c551fff83a 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -55,3 +55,65 @@ POST /groups/:id/projects/:project_id Parameters: + `id` (required) - The ID of a group + `project_id (required) - The ID of a project + + +## Group members + +### List group members + +Get a list of group members viewable by the authenticated user. + +``` +GET /groups/:id/members +``` + +```json +[ + { + id: 1, + username: "raymond_smith", + email: "ray@smith.org", + name: "Raymond Smith", + state: "active", + created_at: "2012-10-22T14:13:35Z", + access_level: 30 + }, + { + id: 2, + username: "john_doe", + email: "joh@doe.org", + name: "John Doe", + state: "active", + created_at: "2012-10-22T14:13:35Z", + access_level: 30 + } +] +``` + +### Add group member + +Adds a user to the list of group members. + +``` +POST /groups/:id/members +``` + +Parameters: + ++ `id` (required) - The ID of a group ++ `user_id` (required) - The ID of a user to add ++ `access_level` (required) - Project access level + + +### Remove user team member + +Removes user from user team. + +``` +DELETE /groups/:id/members/:user_id +``` + +Parameters: + ++ `id` (required) - The ID of a user group ++ `user_id` (required) - The ID of a group member |