gitlab-org--gitlab-foss/doc/api/groups.md

133 lines
2 KiB
Markdown
Raw Normal View History

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
}
2013-02-01 08:59:22 -05:00
]
```
## Details of a group
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
2013-02-01 08:59:22 -05:00
## New group
Creates a new project group. Available only for admin.
2013-02-01 08:59:22 -05:00
```
POST /groups
```
Parameters:
+ `name` (required) - The name of the group
+ `path` (required) - The path of the group
## 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
2013-09-30 05:01:57 -04:00
+ `project_id` (required) - The ID of a project
## Group members
2013-10-02 10:41:01 -04:00
**Group access levels**
The group access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized:
```
GUEST = 10
REPORTER = 20
DEVELOPER = 30
MASTER = 40
OWNER = 50
```
### 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