diff options
author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2013-09-05 08:03:35 -0700 |
---|---|---|
committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2013-09-05 08:03:35 -0700 |
commit | 201158f1dee15accf6abbd7ad5a50af023ba5d23 (patch) | |
tree | 0b9d915163f7a399f74b194a9aba8362f053ce18 /doc/api | |
parent | 9109a207589c3a3d085005ee87049bba6aeecc1a (diff) | |
parent | fadcc251899095e37b97091a03b2025b1f39c7a6 (diff) | |
download | gitlab-ce-201158f1dee15accf6abbd7ad5a50af023ba5d23.tar.gz |
Merge pull request #4990 from karlhungus/feature_group_membership_api
Add group membership api
Diffstat (limited to 'doc/api')
-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 |