debian-mirror-gitlab/doc/api/namespaces.md

71 lines
1.3 KiB
Markdown
Raw Normal View History

2015-09-11 14:41:01 +05:30
# Namespaces
2016-04-02 18:10:28 +05:30
Usernames and groupnames fall under a special category called namespaces.
For users and groups supported API calls see the [users](users.md) and
[groups](groups.md) documentation respectively.
[Pagination](README.md#pagination) is used.
2015-09-11 14:41:01 +05:30
## List namespaces
2016-04-02 18:10:28 +05:30
Get a list of the namespaces of the authenticated user. If the user is an
administrator, a list of all namespaces in the GitLab instance is shown.
2015-09-11 14:41:01 +05:30
```
GET /namespaces
```
2016-04-02 18:10:28 +05:30
Example request:
```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces
```
Example response:
2015-09-11 14:41:01 +05:30
```json
[
{
"id": 1,
"path": "user1",
"kind": "user"
},
{
"id": 2,
"path": "group1",
"kind": "group"
}
]
```
## Search for namespace
2016-04-02 18:10:28 +05:30
Get all namespaces that match a string in their name or path.
2015-09-11 14:41:01 +05:30
```
GET /namespaces?search=foobar
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `search` | string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
Example request:
```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces?search=twitter
```
Example response:
2015-09-11 14:41:01 +05:30
```json
[
{
2016-04-02 18:10:28 +05:30
"id": 4,
"path": "twitter",
"kind": "group"
2015-09-11 14:41:01 +05:30
}
]
```