Commit 41a21912 authored by Karen Carias's avatar Karen Carias

added links to API calls

parent 41469e5c
# Groups # Groups
## List project groups ## List project groups
Get a list of groups. (As user: my groups, as admin: all groups) Get a list of groups. (As user: my groups, as admin: all groups)
``` ```
GET /groups GET /groups
``` ```
```json ```json
[ [
{ {
"id": 1, "id": 1,
"name": "Foobar Group", "name": "Foobar Group",
"path": "foo-bar", "path": "foo-bar",
"description": "An interesting group" "description": "An interesting group"
} }
] ]
``` ```
You can search for groups by name or path, see below. You can search for groups by name or path, see below.
## Details of a group ## Details of a group
Get all details of a group. Get all details of a group.
``` ```
GET /groups/:id GET /groups/:id
``` ```
Parameters: Parameters:
- `id` (required) - The ID or path of a group - `id` (required) - The ID or path of a group
## New group ## New group
Creates a new project group. Available only for users who can create groups. Creates a new project group. Available only for users who can create groups.
``` ```
POST /groups POST /groups
``` ```
Parameters: Parameters:
- `name` (required) - The name of the group - `name` (required) - The name of the group
- `path` (required) - The path of the group - `path` (required) - The path of the group
- `description` (optional) - The group's description - `description` (optional) - The group's description
## Transfer project to group ## Transfer project to group
Transfer a project to the Group namespace. Available only for admin Transfer a project to the Group namespace. Available only for admin
``` ```
POST /groups/:id/projects/:project_id POST /groups/:id/projects/:project_id
``` ```
Parameters: Parameters:
- `id` (required) - The ID or path of a group - `id` (required) - The ID or path of a group
- `project_id` (required) - The ID of a project - `project_id` (required) - The ID of a project
## Remove group ## Remove group
Removes group with all projects inside. Removes group with all projects inside.
``` ```
DELETE /groups/:id DELETE /groups/:id
``` ```
Parameters: Parameters:
- `id` (required) - The ID or path of a user group - `id` (required) - The ID or path of a user group
## Search for group ## Search for group
Get all groups that match your string in their name or path. Get all groups that match your string in their name or path.
``` ```
GET /groups?search=foobar GET /groups?search=foobar
``` ```
```json ```json
[ [
{ {
"id": 1, "id": 1,
"name": "Foobar Group", "name": "Foobar Group",
"path": "foo-bar", "path": "foo-bar",
"description": "An interesting group" "description": "An interesting group"
} }
] ]
``` ```
## Group members ## Group members
**Group access levels** **Group access levels**
The group access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: The group access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized:
``` ```
GUEST = 10 GUEST = 10
REPORTER = 20 REPORTER = 20
DEVELOPER = 30 DEVELOPER = 30
MASTER = 40 MASTER = 40
OWNER = 50 OWNER = 50
``` ```
### List group members ### List group members
Get a list of group members viewable by the authenticated user. Get a list of group members viewable by the authenticated user.
``` ```
GET /groups/:id/members GET /groups/:id/members
``` ```
```json ```json
[ [
{ {
"id": 1, "id": 1,
"username": "raymond_smith", "username": "raymond_smith",
"email": "ray@smith.org", "email": "ray@smith.org",
"name": "Raymond Smith", "name": "Raymond Smith",
"state": "active", "state": "active",
"created_at": "2012-10-22T14:13:35Z", "created_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30
}, },
{ {
"id": 2, "id": 2,
"username": "john_doe", "username": "john_doe",
"email": "joh@doe.org", "email": "joh@doe.org",
"name": "John Doe", "name": "John Doe",
"state": "active", "state": "active",
"created_at": "2012-10-22T14:13:35Z", "created_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30
} }
] ]
``` ```
### Add group member ### Add group member
Adds a user to the list of group members. Adds a user to the list of group members.
``` ```
POST /groups/:id/members POST /groups/:id/members
``` ```
Parameters: Parameters:
- `id` (required) - The ID or path of a group - `id` (required) - The ID or path of a group
- `user_id` (required) - The ID of a user to add - `user_id` (required) - The ID of a user to add
- `access_level` (required) - Project access level - `access_level` (required) - Project access level
### Edit group team member ### Edit group team member
Updates a group team member to a specified access level. Updates a group team member to a specified access level.
``` ```
PUT /groups/:id/members/:user_id PUT /groups/:id/members/:user_id
``` ```
Parameters: Parameters:
- `id` (required) - The ID of a group - `id` (required) - The ID of a group
- `user_id` (required) - The ID of a group member - `user_id` (required) - The ID of a group member
- `access_level` (required) - Project access level - `access_level` (required) - Project access level
### Remove user team member ### Remove user team member
Removes user from user team. Removes user from user team.
``` ```
DELETE /groups/:id/members/:user_id DELETE /groups/:id/members/:user_id
``` ```
Parameters: Parameters:
- `id` (required) - The ID or path of a user group - `id` (required) - The ID or path of a user group
- `user_id` (required) - The ID of a group member - `user_id` (required) - The ID of a group member
## Namespaces in groups ## Namespaces in groups
By default, groups only get 20 namespaces at a time because the API results are paginated. By default, groups only get 20 namespaces at a time because the API results are paginated.
To get more (up to 100), pass the following as an argument to the API call: To get more (up to 100), pass the following as an argument to the API call:
``` ```
per_page=100 /groups?per_page=100
``` ```
And to switch pages add: And to switch pages add:
``` ```
page=2 /groups?per_page=100&page=2
``` ```
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment