kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/groups.md

120 lines
1.8 KiB
Markdown
Raw Normal View History

Add docs/tests for groups api
2013-02-01 08:59:22 -05:00
## List project groups
Get a list of groups. (As user: my groups, as admin: all groups)
```
GET /groups
```
```json
[
{
"id": 1,
"name": "Foobar Group",
"path": "foo-bar",
"owner_id": 18
}
]
```
API: groups documentation updated, functions return different status codes Updates the API documentation of groups with infos to return codes. The function calls in the groups API have updated documentation and return `400 Bad Request` status code if a required attribute is missing.
2013-02-27 06:34:45 -05:00
## Details of a group
Add docs/tests for groups api
2013-02-01 08:59:22 -05:00
Get all details of a group.
```
GET /groups/:id
```
Parameters:
+ `id` (required) - The ID of a group
API: groups documentation updated, functions return different status codes Updates the API documentation of groups with infos to return codes. The function calls in the groups API have updated documentation and return `400 Bad Request` status code if a required attribute is missing.
2013-02-27 06:34:45 -05:00
Add docs/tests for groups api
2013-02-01 08:59:22 -05:00
## New group
API: groups documentation updated, functions return different status codes Updates the API documentation of groups with infos to return codes. The function calls in the groups API have updated documentation and return `400 Bad Request` status code if a required attribute is missing.
2013-02-27 06:34:45 -05:00
Creates a new project group. Available only for admin.
Add docs/tests for groups api
2013-02-01 08:59:22 -05:00
```
POST /groups
```
Parameters:
API: groups documentation updated, functions return different status codes Updates the API documentation of groups with infos to return codes. The function calls in the groups API have updated documentation and return `400 Bad Request` status code if a required attribute is missing.
2013-02-27 06:34:45 -05:00
+ `name` (required) - The name of the group
+ `path` (required) - The path of the group
Updated documentation for added Admin APIs
2013-03-05 23:48:40 -05:00
## Transfer project to group
Transfer a project to the Group namespace. Available only for admin
```
POST /groups/:id/projects/:project_id
```
Parameters:
+ `id` (required) - The ID of a group
Fixed typo in groups.md
2013-09-30 05:01:57 -04:00
+ `project_id` (required) - The ID of a project
Add group membership api Change-Id: I5b174bba02856ede788dcb51ec9b0d598ea7d0df
2013-09-04 11:19:03 -04:00
## 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
Copy permalink