From 8248e1f2b83895f394a3fecd25dcea4a8b40303b Mon Sep 17 00:00:00 2001 From: Izaak Alpert Date: Wed, 4 Sep 2013 11:19:03 -0400 Subject: Add group membership api Change-Id: I5b174bba02856ede788dcb51ec9b0d598ea7d0df --- doc/api/groups.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) (limited to 'doc/api/groups.md') 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 -- cgit v1.2.1