diff options
| author | 🙈 jacopo beschi 🙉 <intrip@gmail.com> | 2018-07-26 00:45:42 +0300 |
|---|---|---|
| committer | Robert Speicher <robert@gitlab.com> | 2018-07-26 00:45:42 +0300 |
| commit | 046796cc3a98068e99abed152145e76c4636959c (patch) | |
| tree | ab7061a86e9e69b56c27835682542a5bc2423942 /doc | |
| parent | 7b6d3974d416bca12360327b147feefeeead01f6 (diff) | |
Resolve "API endpoint that returns all members, including the inherited membership through ancestor group"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/members.md | 75 |
1 files changed, 70 insertions, 5 deletions
diff --git a/doc/api/members.md b/doc/api/members.md index 8ebe464c359..7b228b92594 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -40,7 +40,9 @@ Example response: "username": "raymond_smith", "name": "Raymond Smith", "state": "active", - "created_at": "2012-10-22T14:13:35Z", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", "access_level": 30 }, { @@ -48,7 +50,65 @@ Example response: "username": "john_doe", "name": "John Doe", "state": "active", - "created_at": "2012-10-22T14:13:35Z", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", + "access_level": 30 + } +] +``` + +## List all members of a group or project including inherited members + +Gets a list of group or project members viewable by the authenticated user, including inherited members through ancestor groups. + +``` +GET /groups/:id/members/all +GET /projects/:id/members/all +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `query` | string | no | A query string to search for members | + +```bash +curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/all +curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/members/all +``` + +Example response: + +```json +[ + { + "id": 1, + "username": "raymond_smith", + "name": "Raymond Smith", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", + "access_level": 30 + }, + { + "id": 2, + "username": "john_doe", + "name": "John Doe", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", + "access_level": 30 + }, + { + "id": 3, + "username": "foo_bar", + "name": "Foo bar", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-11-22T14:13:35Z", "access_level": 30 } ] @@ -81,7 +141,8 @@ Example response: "username": "raymond_smith", "name": "Raymond Smith", "state": "active", - "created_at": "2012-10-22T14:13:35Z", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", "access_level": 30, "expires_at": null } @@ -116,7 +177,9 @@ Example response: "username": "raymond_smith", "name": "Raymond Smith", "state": "active", - "created_at": "2012-10-22T14:13:35Z", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", "access_level": 30 } ``` @@ -150,7 +213,9 @@ Example response: "username": "raymond_smith", "name": "Raymond Smith", "state": "active", - "created_at": "2012-10-22T14:13:35Z", + "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", + "web_url": "http://192.168.1.8:3000/root", + "expires_at": "2012-10-22T14:13:35Z", "access_level": 40 } ``` |