Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1 | = Gerrit Code Review - /groups/ REST API |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 2 | |
| 3 | This page describes the group related REST endpoints. |
| 4 | Please also take note of the general information on the |
| 5 | link:rest-api.html[REST API]. |
| 6 | |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 7 | [[group-endpoints]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 8 | == Group Endpoints |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 9 | |
Edwin Kempin | 7620274 | 2013-02-15 13:51:50 +0100 | [diff] [blame] | 10 | [[list-groups]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 11 | === List Groups |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 12 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 13 | 'GET /groups/' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 14 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 15 | |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 16 | Lists the groups accessible by the caller. This is the same as |
| 17 | using the link:cmd-ls-groups.html[ls-groups] command over SSH, |
| 18 | and accepts the same options as query parameters. |
| 19 | |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 20 | As result a map is returned that maps the group names to |
| 21 | link:#group-info[GroupInfo] entries. The entries in the map are sorted |
| 22 | by group name. |
| 23 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 24 | .Request |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 25 | ---- |
| 26 | GET /groups/ HTTP/1.0 |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 27 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 28 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 29 | .Response |
| 30 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 31 | HTTP/1.1 200 OK |
| 32 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 33 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 34 | |
| 35 | )]}' |
| 36 | { |
| 37 | "Administrators": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 38 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 39 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 40 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 41 | }, |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 42 | "description": "Gerrit Site Administrators", |
| 43 | "group_id": 1, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 44 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 45 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 46 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 47 | }, |
| 48 | "Anonymous Users": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 49 | "id": "global%3AAnonymous-Users", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 50 | "url": "#/admin/groups/uuid-global%3AAnonymous-Users", |
| 51 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 52 | }, |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 53 | "description": "Any user, signed-in or not", |
| 54 | "group_id": 2, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 55 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 56 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 57 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 58 | }, |
| 59 | "MyProject_Committers": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 60 | "id": "834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 61 | "url": "#/admin/groups/uuid-834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7", |
| 62 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 63 | "visible_to_all": true, |
| 64 | }, |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 65 | "group_id": 6, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 66 | "owner": "MyProject_Committers", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 67 | "owner_id": "834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7", |
| 68 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 69 | }, |
Patrick Hiesel | e587c40 | 2020-08-07 16:11:29 +0200 | [diff] [blame] | 70 | "Service Users": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 71 | "id": "5057f3cbd3519d6ab69364429a89ffdffba50f73", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 72 | "url": "#/admin/groups/uuid-5057f3cbd3519d6ab69364429a89ffdffba50f73", |
| 73 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 74 | }, |
Patrick Hiesel | e587c40 | 2020-08-07 16:11:29 +0200 | [diff] [blame] | 75 | "description": "Service accounts that interact with Gerrit", |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 76 | "group_id": 4, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 77 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 78 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 79 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 80 | }, |
| 81 | "Project Owners": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 82 | "id": "global%3AProject-Owners", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 83 | "url": "#/admin/groups/uuid-global%3AProject-Owners", |
| 84 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 85 | }, |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 86 | "description": "Any owner of the project", |
| 87 | "group_id": 5, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 88 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 89 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 90 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 91 | }, |
| 92 | "Registered Users": { |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 93 | "id": "global%3ARegistered-Users", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 94 | "url": "#/admin/groups/uuid-global%3ARegistered-Users", |
| 95 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 96 | }, |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 97 | "description": "Any signed-in user", |
| 98 | "group_id": 3, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 99 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 100 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 101 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 102 | } |
| 103 | } |
| 104 | ---- |
| 105 | |
Edwin Kempin | a64c4b9 | 2013-01-23 11:30:40 +0100 | [diff] [blame] | 106 | .Get all groups |
| 107 | **** |
| 108 | get::/groups/ |
| 109 | **** |
| 110 | |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 111 | [[group-options]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 112 | ==== Group Options |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 113 | Additional fields can be obtained by adding `o` parameters, each option |
| 114 | requires more lookups and slows down the query response time to the |
| 115 | client so they are generally disabled by default. Optional fields are: |
| 116 | |
| 117 | [[includes]] |
| 118 | -- |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 119 | * `INCLUDES`: include list of direct subgroups. |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 120 | -- |
| 121 | |
| 122 | [[members]] |
| 123 | -- |
| 124 | * `MEMBERS`: include list of direct group members. |
| 125 | -- |
| 126 | |
David Pursehouse | 0442e597 | 2017-09-22 20:44:29 +0900 | [diff] [blame] | 127 | ==== Find groups that are owned by another group |
| 128 | |
David Pursehouse | 1927519 | 2020-05-07 10:39:40 +0900 | [diff] [blame] | 129 | By setting `owned-by` and specifying the link:#group-id[\{group-id\}] of another |
David Pursehouse | 0442e597 | 2017-09-22 20:44:29 +0900 | [diff] [blame] | 130 | group, it is possible to find all the groups for which the owning group is the |
| 131 | given group. |
| 132 | |
| 133 | .Request |
| 134 | ---- |
David Pursehouse | 1927519 | 2020-05-07 10:39:40 +0900 | [diff] [blame] | 135 | GET /groups/?owned-by=7ca042f4d5847936fcb90ca91057673157fd06fc HTTP/1.0 |
David Pursehouse | 0442e597 | 2017-09-22 20:44:29 +0900 | [diff] [blame] | 136 | ---- |
| 137 | |
| 138 | .Response |
| 139 | ---- |
| 140 | HTTP/1.1 200 OK |
| 141 | Content-Disposition: attachment |
| 142 | Content-Type: application/json; charset=UTF-8 |
| 143 | |
| 144 | )]}' |
| 145 | { |
| 146 | "MyProject-Committers": { |
| 147 | "id": "9999c971bb4ab872aab759d8c49833ee6b9ff320", |
| 148 | "url": "#/admin/groups/uuid-9999c971bb4ab872aab759d8c49833ee6b9ff320", |
| 149 | "options": { |
| 150 | "visible_to_all": true |
| 151 | }, |
| 152 | "description":"contains all committers for MyProject", |
| 153 | "group_id": 551, |
| 154 | "owner": "MyProject-Owners", |
| 155 | "owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 156 | "created_on": "2013-02-01 09:59:32.126000000" |
| 157 | } |
| 158 | } |
| 159 | ---- |
| 160 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 161 | ==== Check if a group is owned by the calling user |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 162 | By setting the option `owned` and specifying a group to inspect with |
Edwin Kempin | a757d71 | 2017-01-16 14:46:43 +0100 | [diff] [blame] | 163 | the option `group`/`g`, it is possible to find out if this group is |
| 164 | owned by the calling user. |
| 165 | |
| 166 | [NOTE] Earlier the `group`/`g` option was named `query`/`q`. Using |
| 167 | `query`/`q` still works, but this option is deprecated and may be |
| 168 | removed in future. Hence all users should be adapted to use |
| 169 | `group`/`g` instead. |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 170 | |
| 171 | .Request |
| 172 | ---- |
| 173 | GET /groups/?owned&q=MyProject-Committers HTTP/1.0 |
| 174 | ---- |
| 175 | |
| 176 | If the group is owned by the calling user, the returned map contains |
| 177 | this group. If the calling user doesn't own this group an empty map is |
| 178 | returned. |
| 179 | |
| 180 | .Response |
| 181 | ---- |
| 182 | HTTP/1.1 200 OK |
| 183 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 184 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 185 | |
| 186 | )]}' |
| 187 | { |
| 188 | "MyProject-Committers": { |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 189 | "id": "9999c971bb4ab872aab759d8c49833ee6b9ff320", |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 190 | "url": "#/admin/groups/uuid-9999c971bb4ab872aab759d8c49833ee6b9ff320", |
| 191 | "options": { |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 192 | "visible_to_all": true |
| 193 | }, |
| 194 | "description":"contains all committers for MyProject", |
| 195 | "group_id": 551, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 196 | "owner": "MyProject-Owners", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 197 | "owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 198 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | a3b4b63 | 2013-02-11 10:33:55 +0100 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | ---- |
| 202 | |
Anthony Chin | dc78329 | 2014-04-10 11:14:41 -0400 | [diff] [blame] | 203 | [[group-limit]] |
| 204 | ==== Group Limit |
| 205 | The `/groups/` URL also accepts a limit integer in the `n` parameter. |
| 206 | This limits the results to show `n` groups. |
| 207 | |
| 208 | Query the first 25 groups in group list. |
| 209 | ---- |
| 210 | GET /groups/?n=25 HTTP/1.0 |
| 211 | ---- |
| 212 | |
| 213 | The `/groups/` URL also accepts a start integer in the `S` parameter. |
| 214 | The results will skip `S` groups from group list. |
| 215 | |
| 216 | Query 25 groups starting from index 50. |
| 217 | ---- |
| 218 | GET /groups/?n=25&S=50 HTTP/1.0 |
| 219 | ---- |
| 220 | |
Yuxuan 'fishy' Wang | 8c48525 | 2015-09-08 17:53:23 -0700 | [diff] [blame] | 221 | [[suggest-group]] |
| 222 | ==== Suggest Group |
David Pursehouse | 9b9bdec | 2016-02-18 14:21:20 +0900 | [diff] [blame] | 223 | The `suggest` or `s` option indicates a user-entered string that |
Yuxuan 'fishy' Wang | 8c48525 | 2015-09-08 17:53:23 -0700 | [diff] [blame] | 224 | should be auto-completed to group names. |
| 225 | If this option is set and `n` is not set, then `n` defaults to 10. |
| 226 | |
David Pursehouse | 9b9bdec | 2016-02-18 14:21:20 +0900 | [diff] [blame] | 227 | When using this option, the `project` or `p` option can be used to |
| 228 | name the current project, to allow context-dependent suggestions. |
Yuxuan 'fishy' Wang | 8c48525 | 2015-09-08 17:53:23 -0700 | [diff] [blame] | 229 | |
Edwin Kempin | a757d71 | 2017-01-16 14:46:43 +0100 | [diff] [blame] | 230 | Not compatible with `visible-to-all`, `owned`, `user`, `match`, |
| 231 | `group`, or `S`. |
Yuxuan 'fishy' Wang | 8c48525 | 2015-09-08 17:53:23 -0700 | [diff] [blame] | 232 | (Attempts to use one of those options combined with `suggest` will |
| 233 | error out.) |
| 234 | |
| 235 | .Request |
| 236 | ---- |
| 237 | GET /groups/?suggest=ad&p=All-Projects HTTP/1.0 |
| 238 | ---- |
| 239 | |
| 240 | .Response |
| 241 | ---- |
| 242 | HTTP/1.1 200 OK |
| 243 | Content-Disposition: attachment |
| 244 | Content-Type: application/json; charset=UTF-8 |
| 245 | |
| 246 | )]}' |
| 247 | { |
| 248 | "Administrators": { |
| 249 | "url": "#/admin/groups/uuid-59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
| 250 | "options": {}, |
| 251 | "description": "Gerrit Site Administrators", |
| 252 | "group_id": 1, |
| 253 | "owner": "Administrators", |
| 254 | "owner_id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 255 | "created_on": "2013-02-01 09:59:32.126000000", |
Yuxuan 'fishy' Wang | 8c48525 | 2015-09-08 17:53:23 -0700 | [diff] [blame] | 256 | "id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b" |
| 257 | } |
| 258 | } |
| 259 | ---- |
| 260 | |
David Pursehouse | 969e674 | 2017-07-12 20:12:26 +0900 | [diff] [blame] | 261 | Regex(r):: |
| 262 | Limit the results to those groups that match the specified regex. |
| 263 | + |
| 264 | Boundary matchers '^' and '$' are implicit. For example: the regex 'test.*' will |
| 265 | match any groups that start with 'test' and regex '.*test' will match any |
| 266 | group that end with 'test'. |
| 267 | + |
| 268 | The match is case sensitive. |
| 269 | + |
| 270 | List all groups that match regex `test.*group`: |
| 271 | + |
| 272 | .Request |
| 273 | ---- |
| 274 | GET /groups/?r=test.*group HTTP/1.0 |
| 275 | ---- |
| 276 | + |
| 277 | .Response |
| 278 | ---- |
| 279 | HTTP/1.1 200 OK |
| 280 | Content-Disposition: attachment |
| 281 | Content-Type: application/json; charset=UTF-8 |
| 282 | |
| 283 | )]}' |
| 284 | { |
| 285 | "test/some-group": { |
| 286 | "url": "#/admin/groups/uuid-59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
| 287 | "options": {}, |
| 288 | "description": "Gerrit Site Administrators", |
| 289 | "group_id": 1, |
| 290 | "owner": "Administrators", |
| 291 | "owner_id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
| 292 | "created_on": "2013-02-01 09:59:32.126000000", |
| 293 | "id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b" |
| 294 | } |
| 295 | "test/some-other-group": { |
| 296 | "url": "#/admin/groups/uuid-99b92f35489e62c80d1ab1bf0c2d17843038df8b", |
| 297 | "options": {}, |
| 298 | "description": "Gerrit Site Administrators", |
| 299 | "group_id": 1, |
| 300 | "owner": "Administrators", |
| 301 | "owner_id": "99b92f35489e62c80d1ab1bf0c2d17843038df8b", |
| 302 | "created_on": "2014-02-01 09:59:32.126000000", |
| 303 | "id": "99b92f35489e62c80d1ab1bf0c2d17843038df8b" |
| 304 | } |
| 305 | } |
| 306 | |
| 307 | ---- |
| 308 | |
Paladox none | 3cbb530 | 2017-07-11 13:41:03 +0000 | [diff] [blame] | 309 | Substring(m):: |
| 310 | Limit the results to those groups that match the specified substring. |
| 311 | + |
David Pursehouse | 3cd948d | 2017-07-13 09:52:03 +0900 | [diff] [blame] | 312 | The match is case insensitive. |
| 313 | + |
Paladox none | 3cbb530 | 2017-07-11 13:41:03 +0000 | [diff] [blame] | 314 | List all groups that match substring `test/`: |
| 315 | + |
| 316 | .Request |
| 317 | ---- |
| 318 | GET /groups/?m=test%2F HTTP/1.0 |
| 319 | ---- |
| 320 | + |
| 321 | .Response |
| 322 | ---- |
| 323 | HTTP/1.1 200 OK |
| 324 | Content-Disposition: attachment |
| 325 | Content-Type: application/json; charset=UTF-8 |
| 326 | |
| 327 | )]}' |
| 328 | { |
| 329 | "test/test": { |
| 330 | "url": "#/admin/groups/uuid-786a95e85f9a2223a96545f10003f396aba871f2", |
| 331 | "options": {}, |
| 332 | "group_id": 15, |
| 333 | "owner": "test/test", |
| 334 | "owner_id": "786a95e85f9a2223a96545f10003f396aba871f2", |
| 335 | "created_on": "2017-07-11 13:56:24.000000000", |
| 336 | "id": "786a95e85f9a2223a96545f10003f396aba871f2" |
| 337 | } |
| 338 | } |
| 339 | ---- |
| 340 | |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 341 | [[query-groups]] |
| 342 | === Query Groups |
| 343 | -- |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 344 | 'GET /groups/?query=<query>' |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 345 | -- |
| 346 | |
| 347 | Queries internal groups visible to the caller. The |
| 348 | link:user-search-groups.html#_search_operators[query string] must be |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 349 | provided by the `query` parameter. The `start` and `limit` parameters |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 350 | can be used to skip/limit results. |
| 351 | |
| 352 | As result a list of link:#group-info[GroupInfo] entities is returned. |
| 353 | |
| 354 | .Request |
| 355 | ---- |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 356 | GET /groups/?query=inname:test HTTP/1.0 |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 357 | ---- |
| 358 | |
| 359 | .Response |
| 360 | ---- |
| 361 | HTTP/1.1 200 OK |
| 362 | Content-Disposition: attachment |
| 363 | Content-Type: application/json; charset=UTF-8 |
| 364 | |
| 365 | )]}' |
| 366 | [ |
| 367 | { |
Edwin Kempin | a45b072 | 2017-01-03 16:15:01 +0100 | [diff] [blame] | 368 | "url": "#/admin/groups/uuid-68236a40ca78de8be630312d8ba50250bc5638ae", |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 369 | "options": {}, |
Edwin Kempin | a45b072 | 2017-01-03 16:15:01 +0100 | [diff] [blame] | 370 | "description": "Group for running tests on MyProject", |
| 371 | "group_id": 20, |
| 372 | "owner": "MyProject-Test-Group", |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 373 | "owner_id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 374 | "created_on": "2013-02-01 09:59:32.126000000", |
Edwin Kempin | a45b072 | 2017-01-03 16:15:01 +0100 | [diff] [blame] | 375 | "id": "68236a40ca78de8be630312d8ba50250bc5638ae" |
| 376 | }, |
| 377 | { |
| 378 | "url": "#/admin/groups/uuid-99a534526313324a2667025c3f4e089199b736aa", |
| 379 | "options": {}, |
| 380 | "description": "Testers for ProjectX", |
| 381 | "group_id": 17, |
| 382 | "owner": "ProjectX-Testers", |
| 383 | "owner_id": "59b92f35489e62c80d1ab1bf0c2d17843038df8b", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 384 | "created_on": "2013-02-01 09:59:32.126000000", |
Edwin Kempin | a45b072 | 2017-01-03 16:15:01 +0100 | [diff] [blame] | 385 | "id": "99a534526313324a2667025c3f4e089199b736aa" |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 386 | } |
| 387 | ] |
| 388 | ---- |
| 389 | |
Edwin Kempin | fadf363 | 2017-01-03 15:16:17 +0100 | [diff] [blame] | 390 | If the number of groups matching the query exceeds either the internal |
| 391 | limit or a supplied `limit` query parameter, the last group object has |
| 392 | a `_more_groups: true` JSON field set. |
| 393 | |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 394 | [[group-query-limit]] |
| 395 | ==== Group Limit |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 396 | The `/groups/?query=<query>` URL also accepts a limit integer in the |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 397 | `limit` parameter. This limits the results to `limit` groups. |
| 398 | |
| 399 | Query the first 25 groups in group list. |
| 400 | ---- |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 401 | GET /groups/?query=<query>&limit=25 HTTP/1.0 |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 402 | ---- |
| 403 | |
| 404 | The `/groups/` URL also accepts a start integer in the `start` |
| 405 | parameter. The results will skip `start` groups from group list. |
| 406 | |
| 407 | Query 25 groups starting from index 50. |
| 408 | ---- |
David Pursehouse | b9e70b3 | 2019-09-27 16:55:11 +0900 | [diff] [blame] | 409 | GET /groups/?query=<query>&limit=25&start=50 HTTP/1.0 |
Edwin Kempin | 6cfbb29 | 2017-01-04 09:40:50 +0100 | [diff] [blame] | 410 | ---- |
| 411 | |
| 412 | [[group-query-options]] |
| 413 | ==== Group Options |
| 414 | Additional fields can be obtained by adding `o` parameters. Each option |
| 415 | requires more lookups and slows down the query response time to the |
| 416 | client so they are generally disabled by default. The supported fields |
| 417 | are described in the context of the link:#group-options[List Groups] |
| 418 | REST endpoint. |
| 419 | |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 420 | [[get-group]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 421 | === Get Group |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 422 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 423 | 'GET /groups/link:#group-id[\{group-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 424 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 425 | |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 426 | Retrieves a group. |
| 427 | |
| 428 | .Request |
| 429 | ---- |
| 430 | GET /groups/6a1e70e1a88782771a91808c8af9bbb7a9871389 HTTP/1.0 |
| 431 | ---- |
| 432 | |
| 433 | As response a link:#group-info[GroupInfo] entity is returned that |
| 434 | describes the group. |
| 435 | |
| 436 | .Response |
| 437 | ---- |
| 438 | HTTP/1.1 200 OK |
| 439 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 440 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 441 | |
| 442 | )]}' |
| 443 | { |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 444 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 445 | "name": "Administrators", |
| 446 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 447 | "options": { |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 448 | }, |
| 449 | "description": "Gerrit Site Administrators", |
| 450 | "group_id": 1, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 451 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 452 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 453 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 454 | } |
| 455 | ---- |
| 456 | |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 457 | [[create-group]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 458 | === Create Group |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 459 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 460 | 'PUT /groups/link:#group-name[\{group-name\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 461 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 462 | |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 463 | Creates a new Gerrit internal group. |
| 464 | |
| 465 | In the request body additional data for the group can be provided as |
| 466 | link:#group-input[GroupInput]. |
| 467 | |
| 468 | .Request |
| 469 | ---- |
| 470 | PUT /groups/MyProject-Committers HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 471 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 472 | |
| 473 | { |
| 474 | "description": "contains all committers for MyProject", |
| 475 | "visible_to_all": true, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 476 | "owner": "MyProject-Owners", |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 477 | "owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc" |
| 478 | } |
| 479 | ---- |
| 480 | |
| 481 | As response the link:#group-info[GroupInfo] entity is returned that |
| 482 | describes the created group. |
| 483 | |
| 484 | .Response |
| 485 | ---- |
| 486 | HTTP/1.1 201 Created |
| 487 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 488 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 489 | |
| 490 | )]}' |
| 491 | { |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 492 | "id": "9999c971bb4ab872aab759d8c49833ee6b9ff320", |
| 493 | "name": "MyProject-Committers", |
| 494 | "url": "#/admin/groups/uuid-9999c971bb4ab872aab759d8c49833ee6b9ff320", |
| 495 | "options": { |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 496 | "visible_to_all": true |
| 497 | }, |
| 498 | "description":"contains all committers for MyProject", |
| 499 | "group_id": 551, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 500 | "owner": "MyProject-Owners", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 501 | "owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 502 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 503 | } |
| 504 | ---- |
| 505 | |
David Pursehouse | 666b34d | 2019-09-09 09:08:56 +0900 | [diff] [blame] | 506 | If the group creation fails because the name is already in use, or the |
| 507 | UUID was specified and the UUID is already in use, the response is |
| 508 | "`409 Conflict`". |
Edwin Kempin | 0aa2710 | 2013-02-27 16:44:16 +0100 | [diff] [blame] | 509 | |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 510 | [[get-group-detail]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 511 | === Get Group Detail |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 512 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 513 | 'GET /groups/link:#group-id[\{group-id\}]/detail' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 514 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 515 | |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 516 | Retrieves a group with the direct link:#members[members] and the |
| 517 | directly link:#includes[included groups]. |
| 518 | |
| 519 | .Request |
| 520 | ---- |
| 521 | GET /groups/6a1e70e1a88782771a91808c8af9bbb7a9871389/detail HTTP/1.0 |
| 522 | ---- |
| 523 | |
| 524 | As response a link:#group-info[GroupInfo] entity is returned that |
| 525 | describes the group. |
| 526 | |
| 527 | .Response |
| 528 | ---- |
| 529 | HTTP/1.1 200 OK |
| 530 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 531 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 532 | |
| 533 | )]}' |
| 534 | { |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 535 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 536 | "name": "Administrators", |
| 537 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 538 | "options": { |
| 539 | }, |
| 540 | "description": "Gerrit Site Administrators", |
| 541 | "group_id": 1, |
| 542 | "owner": "Administrators", |
| 543 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 544 | "created_on": "2013-02-01 09:59:32.126000000", |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 545 | "members": [ |
| 546 | { |
Edwin Kempin | 51284e6 | 2013-03-05 15:26:41 +0100 | [diff] [blame] | 547 | "_account_id": 1000097, |
| 548 | "name": "Jane Roe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 549 | "email": "jane.roe@example.com", |
| 550 | "username": "jane" |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 551 | }, |
| 552 | { |
Edwin Kempin | 51284e6 | 2013-03-05 15:26:41 +0100 | [diff] [blame] | 553 | "_account_id": 1000096, |
| 554 | "name": "John Doe", |
| 555 | "email": "john.doe@example.com" |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 556 | "username": "john" |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 557 | } |
| 558 | ], |
| 559 | "includes": [] |
| 560 | } |
| 561 | ---- |
| 562 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 563 | [[get-group-name]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 564 | === Get Group Name |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 565 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 566 | 'GET /groups/link:#group-id[\{group-id\}]/name' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 567 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 568 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 569 | Retrieves the name of a group. |
| 570 | |
| 571 | .Request |
| 572 | ---- |
| 573 | GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/name HTTP/1.0 |
| 574 | ---- |
| 575 | |
| 576 | .Response |
| 577 | ---- |
| 578 | HTTP/1.1 200 OK |
| 579 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 580 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 581 | |
| 582 | )]}' |
| 583 | "MyProject-Committers" |
| 584 | ---- |
| 585 | |
| 586 | [[rename-group]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 587 | === Rename Group |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 588 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 589 | 'PUT /groups/link:#group-id[\{group-id\}]/name' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 590 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 591 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 592 | Renames a Gerrit internal group. |
| 593 | |
| 594 | The new group name must be provided in the request body. |
| 595 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 596 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 597 | non-internal group will return 405 Method Not Allowed. |
| 598 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 599 | .Request |
| 600 | ---- |
| 601 | PUT /groups/MyProject-Committers/name HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 602 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 603 | |
| 604 | { |
| 605 | "name": "My-Project-Committers" |
| 606 | } |
| 607 | ---- |
| 608 | |
| 609 | As response the new group name is returned. |
| 610 | |
| 611 | .Response |
| 612 | ---- |
| 613 | HTTP/1.1 200 OK |
| 614 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 615 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 616 | |
| 617 | )]}' |
| 618 | "My-Project-Committers" |
| 619 | ---- |
| 620 | |
Edwin Kempin | 0aa2710 | 2013-02-27 16:44:16 +0100 | [diff] [blame] | 621 | If renaming the group fails because the new name is already in use the |
| 622 | response is "`409 Conflict`". |
| 623 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 624 | [[get-group-description]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 625 | === Get Group Description |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 626 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 627 | 'GET /groups/link:#group-id[\{group-id\}]/description' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 628 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 629 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 630 | Retrieves the description of a group. |
| 631 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 632 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 633 | non-internal group will return 405 Method Not Allowed. |
| 634 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 635 | .Request |
| 636 | ---- |
| 637 | GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/description HTTP/1.0 |
| 638 | ---- |
| 639 | |
| 640 | .Response |
| 641 | ---- |
| 642 | HTTP/1.1 200 OK |
| 643 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 644 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 645 | |
| 646 | )]}' |
| 647 | "contains all committers for MyProject" |
| 648 | ---- |
| 649 | |
Edwin Kempin | efec449 | 2013-02-22 10:09:23 +0100 | [diff] [blame] | 650 | If the group does not have a description an empty string is returned. |
| 651 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 652 | [[set-group-description]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 653 | === Set Group Description |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 654 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 655 | 'PUT /groups/link:#group-id[\{group-id\}]/description' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 656 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 657 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 658 | Sets the description of a Gerrit internal group. |
| 659 | |
| 660 | The new group description must be provided in the request body. |
| 661 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 662 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 663 | non-internal group will return 405 Method Not Allowed. |
| 664 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 665 | .Request |
| 666 | ---- |
| 667 | PUT /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/description HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 668 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 669 | |
| 670 | { |
| 671 | "description": "The committers of MyProject." |
| 672 | } |
| 673 | ---- |
| 674 | |
| 675 | As response the new group description is returned. |
| 676 | |
| 677 | .Response |
| 678 | ---- |
| 679 | HTTP/1.1 200 OK |
| 680 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 681 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 682 | |
| 683 | )]}' |
| 684 | "The committers of MyProject." |
| 685 | ---- |
| 686 | |
Edwin Kempin | 114ab16 | 2013-02-28 09:25:37 +0100 | [diff] [blame] | 687 | If the description was deleted the response is "`204 No Content`". |
| 688 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 689 | [[delete-group-description]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 690 | === Delete Group Description |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 691 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 692 | 'DELETE /groups/link:#group-id[\{group-id\}]/description' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 693 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 694 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 695 | Deletes the description of a Gerrit internal group. |
| 696 | |
| 697 | .Request |
| 698 | ---- |
| 699 | DELETE /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/description HTTP/1.0 |
| 700 | ---- |
| 701 | |
| 702 | .Response |
| 703 | ---- |
| 704 | HTTP/1.1 204 No Content |
| 705 | ---- |
| 706 | |
| 707 | [[get-group-options]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 708 | === Get Group Options |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 709 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 710 | 'GET /groups/link:#group-id[\{group-id\}]/options' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 711 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 712 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 713 | Retrieves the options of a group. |
| 714 | |
| 715 | .Request |
| 716 | ---- |
| 717 | GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/options HTTP/1.0 |
| 718 | ---- |
| 719 | |
| 720 | As response a link:#group-options-info[GroupOptionsInfo] entity is |
| 721 | returned that describes the options of the group. |
| 722 | |
| 723 | .Response |
| 724 | ---- |
| 725 | HTTP/1.1 200 OK |
| 726 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 727 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 728 | |
| 729 | )]}' |
| 730 | { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 731 | "visible_to_all": true |
| 732 | } |
| 733 | ---- |
| 734 | |
| 735 | [[set-group-options]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 736 | === Set Group Options |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 737 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 738 | 'PUT /groups/link:#group-id[\{group-id\}]/options' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 739 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 740 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 741 | Sets the options of a Gerrit internal group. |
| 742 | |
| 743 | The new group options must be provided in the request body as a |
| 744 | link:#group-options-input[GroupOptionsInput] entity. |
| 745 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 746 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 747 | non-internal group will return 405 Method Not Allowed. |
| 748 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 749 | .Request |
| 750 | ---- |
| 751 | PUT /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/options HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 752 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 753 | |
| 754 | { |
| 755 | "visible_to_all": true |
| 756 | } |
| 757 | ---- |
| 758 | |
| 759 | As response the new group options are returned as a |
| 760 | link:#group-options-info[GroupOptionsInfo] entity. |
| 761 | |
| 762 | .Response |
| 763 | ---- |
| 764 | HTTP/1.1 200 OK |
| 765 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 766 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 767 | |
| 768 | )]}' |
| 769 | { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 770 | "visible_to_all": true |
| 771 | } |
| 772 | ---- |
| 773 | |
| 774 | [[get-group-owner]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 775 | === Get Group Owner |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 776 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 777 | 'GET /groups/link:#group-id[\{group-id\}]/owner' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 778 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 779 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 780 | Retrieves the owner group of a Gerrit internal group. |
| 781 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 782 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 783 | non-internal group will return 405 Method Not Allowed. |
| 784 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 785 | .Request |
| 786 | ---- |
| 787 | GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/owner HTTP/1.0 |
| 788 | ---- |
| 789 | |
| 790 | As response a link:#group-info[GroupInfo] entity is returned that |
| 791 | describes the owner group. |
| 792 | |
| 793 | .Response |
| 794 | ---- |
| 795 | HTTP/1.1 200 OK |
| 796 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 797 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 798 | |
| 799 | )]}' |
| 800 | { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 801 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 802 | "name": "Administrators", |
| 803 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 804 | "options": { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 805 | }, |
| 806 | "description": "Gerrit Site Administrators", |
| 807 | "group_id": 1, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 808 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 809 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 810 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 811 | } |
| 812 | ---- |
| 813 | |
| 814 | [[set-group-owner]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 815 | === Set Group Owner |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 816 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 817 | 'PUT /groups/link:#group-id[\{group-id\}]/owner' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 818 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 819 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 820 | Sets the owner group of a Gerrit internal group. |
| 821 | |
| 822 | The new owner group must be provided in the request body. |
| 823 | |
Edwin Kempin | c977090 | 2013-02-15 15:38:03 +0100 | [diff] [blame] | 824 | The new owner can be specified by name, by group UUID or by the legacy |
| 825 | numeric group ID. |
| 826 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 827 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 828 | non-internal group will return 405 Method Not Allowed. |
| 829 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 830 | .Request |
| 831 | ---- |
Paladox none | f6e8301 | 2017-06-18 21:17:57 +0000 | [diff] [blame] | 832 | PUT /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/owner HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 833 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 834 | |
| 835 | { |
| 836 | "owner": "6a1e70e1a88782771a91808c8af9bbb7a9871389" |
| 837 | } |
| 838 | ---- |
| 839 | |
| 840 | As response a link:#group-info[GroupInfo] entity is returned that |
| 841 | describes the new owner group. |
| 842 | |
| 843 | .Response |
| 844 | ---- |
| 845 | HTTP/1.1 200 OK |
| 846 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 847 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 848 | |
| 849 | )]}' |
| 850 | { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 851 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 852 | "name": "Administrators", |
| 853 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 854 | "options": { |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 855 | }, |
| 856 | "description": "Gerrit Site Administrators", |
| 857 | "group_id": 1, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 858 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 859 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 860 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 861 | } |
| 862 | ---- |
| 863 | |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 864 | [[get-audit-log]] |
| 865 | === Get Audit Log |
| 866 | -- |
| 867 | 'GET /groups/link:#group-id[\{group-id\}]/log.audit' |
| 868 | -- |
| 869 | |
| 870 | Gets the audit log of a Gerrit internal group. |
| 871 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 872 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 873 | non-internal group will return 405 Method Not Allowed. |
| 874 | |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 875 | .Request |
| 876 | ---- |
| 877 | GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/log.audit HTTP/1.0 |
| 878 | ---- |
| 879 | |
| 880 | As response a list of link:#group-audit-event-info[GroupAuditEventInfo] |
| 881 | entities is returned that describes the audit events of the group. The |
| 882 | returned audit events are sorted by date in reverse order so that the |
| 883 | newest audit event comes first. |
| 884 | |
| 885 | .Response |
| 886 | ---- |
| 887 | HTTP/1.1 200 OK |
| 888 | Content-Disposition: attachment |
| 889 | Content-Type: application/json; charset=UTF-8 |
| 890 | |
| 891 | )]}' |
| 892 | [ |
| 893 | { |
| 894 | "member": { |
| 895 | "url": "#/admin/groups/uuid-fdda826a0815859ab48d22a05a43472f0f55f89a", |
| 896 | "options": {}, |
| 897 | "group_id": 3, |
| 898 | "owner": "Administrators", |
| 899 | "owner_id": "e56678641565e7f59dd5c6878f5bcbc842bf150a", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 900 | "created_on": "2013-02-01 09:59:32.126000000", |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 901 | "id": "fdda826a0815859ab48d22a05a43472f0f55f89a", |
| 902 | "name": "MyGroup" |
| 903 | }, |
| 904 | "type": "REMOVE_GROUP", |
| 905 | "user": { |
| 906 | "_account_id": 1000000, |
| 907 | "name": "Administrator", |
| 908 | "email": "admin@example.com", |
| 909 | "username": "admin" |
| 910 | }, |
| 911 | "date": "2015-07-03 09:22:26.348000000" |
| 912 | }, |
| 913 | { |
| 914 | "member": { |
| 915 | "url": "#/admin/groups/uuid-fdda826a0815859ab48d22a05a43472f0f55f89a", |
| 916 | "options": {}, |
| 917 | "group_id": 3, |
| 918 | "owner": "Administrators", |
| 919 | "owner_id": "e56678641565e7f59dd5c6878f5bcbc842bf150a", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 920 | "created_on": "2013-02-01 09:59:32.126000000", |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 921 | "id": "fdda826a0815859ab48d22a05a43472f0f55f89a", |
| 922 | "name": "MyGroup" |
| 923 | }, |
| 924 | "type": "ADD_GROUP", |
| 925 | "user": { |
| 926 | "_account_id": 1000000, |
| 927 | "name": "Administrator", |
| 928 | "email": "admin@example.com", |
| 929 | "username": "admin" |
| 930 | }, |
| 931 | "date": "2015-07-03 08:43:36.592000000" |
| 932 | }, |
| 933 | { |
| 934 | "member": { |
| 935 | "_account_id": 1000000, |
| 936 | "name": "Administrator", |
| 937 | "email": "admin@example.com", |
| 938 | "username": "admin" |
| 939 | }, |
| 940 | "type": "ADD_USER", |
| 941 | "user": { |
| 942 | "_account_id": 1000001, |
| 943 | "name": "John Doe", |
| 944 | "email": "john.doe@example.com", |
| 945 | "username": "jdoe" |
| 946 | }, |
| 947 | "date": "2015-07-01 13:36:36.602000000" |
| 948 | } |
| 949 | ] |
| 950 | ---- |
| 951 | |
Edwin Kempin | 4550a25 | 2017-01-04 14:22:02 +0100 | [diff] [blame] | 952 | [[index-group]] |
| 953 | === Index Group |
| 954 | -- |
| 955 | 'POST /groups/link:#group-id[\{group-id\}]/index' |
| 956 | -- |
| 957 | |
| 958 | Adds or updates the internal group in the secondary index. |
| 959 | |
| 960 | .Request |
| 961 | ---- |
| 962 | POST /groups/fdda826a0815859ab48d22a05a43472f0f55f89a/index HTTP/1.0 |
| 963 | ---- |
| 964 | |
| 965 | .Response |
| 966 | ---- |
| 967 | HTTP/1.1 204 No Content |
| 968 | ---- |
| 969 | |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 970 | [[group-member-endpoints]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 971 | == Group Member Endpoints |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 972 | |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 973 | [[group-members]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 974 | === List Group Members |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 975 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 976 | 'GET /groups/link:#group-id[\{group-id\}]/members/' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 977 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 978 | |
Edwin Kempin | 2dc5edc | 2013-02-11 15:57:36 +0100 | [diff] [blame] | 979 | Lists the direct members of a Gerrit internal group. |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 980 | |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 981 | As result a list of detailed link:rest-api-accounts.html#account-info[ |
| 982 | AccountInfo] entries is returned. The entries in the list are sorted by |
| 983 | full name, preferred email and id. |
Edwin Kempin | 4156d6e0 | 2013-02-04 15:10:39 +0100 | [diff] [blame] | 984 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 985 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 986 | non-internal group will return 405 Method Not Allowed. |
| 987 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 988 | .Request |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 989 | ---- |
| 990 | GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/members/ HTTP/1.0 |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 991 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 992 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 993 | .Response |
| 994 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 995 | HTTP/1.1 200 OK |
| 996 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 997 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 998 | |
| 999 | )]}' |
| 1000 | [ |
| 1001 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1002 | "_account_id": 1000097, |
| 1003 | "name": "Jane Roe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1004 | "email": "jane.roe@example.com", |
| 1005 | "username": "jane" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1006 | }, |
| 1007 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1008 | "_account_id": 1000096, |
| 1009 | "name": "John Doe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1010 | "email": "john.doe@example.com", |
| 1011 | "username": "john" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1012 | } |
| 1013 | ] |
| 1014 | ---- |
| 1015 | |
Edwin Kempin | a64c4b9 | 2013-01-23 11:30:40 +0100 | [diff] [blame] | 1016 | .Get all members of the 'Administrators' group (normally group id = 1) |
| 1017 | **** |
| 1018 | get::/groups/1/members/ |
| 1019 | **** |
| 1020 | |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1021 | To resolve the included groups of a group recursively and to list all |
| 1022 | members the parameter `recursive` can be set. |
| 1023 | |
Edwin Kempin | d54de1c | 2013-03-08 16:37:14 +0100 | [diff] [blame] | 1024 | Members from included external groups and from included groups which |
| 1025 | are not visible to the calling user are ignored. |
| 1026 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 1027 | .Request |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1028 | ---- |
| 1029 | GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/members/?recursive HTTP/1.0 |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 1030 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1031 | |
Edwin Kempin | 3744083 | 2013-02-06 11:36:00 +0100 | [diff] [blame] | 1032 | .Response |
| 1033 | ---- |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1034 | HTTP/1.1 200 OK |
| 1035 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1036 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1037 | |
| 1038 | )]}' |
| 1039 | [ |
| 1040 | { |
Edwin Kempin | 3e22d48 | 2013-03-05 15:35:25 +0100 | [diff] [blame] | 1041 | "_account_id": 1000097, |
| 1042 | "name": "Jane Roe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1043 | "email": "jane.roe@example.com", |
| 1044 | "username": "jane" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1045 | }, |
| 1046 | { |
Edwin Kempin | 3e22d48 | 2013-03-05 15:35:25 +0100 | [diff] [blame] | 1047 | "_account_id": 1000096, |
| 1048 | "name": "John Doe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1049 | "email": "john.doe@example.com", |
| 1050 | "username": "john" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1051 | }, |
| 1052 | { |
Edwin Kempin | 3e22d48 | 2013-03-05 15:35:25 +0100 | [diff] [blame] | 1053 | "_account_id": 1000098, |
| 1054 | "name": "Richard Roe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1055 | "email": "richard.roe@example.com", |
| 1056 | "username": "rroe" |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1057 | } |
| 1058 | ] |
| 1059 | ---- |
| 1060 | |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1061 | [[get-group-member]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1062 | === Get Group Member |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1063 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1064 | 'GET /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1065 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1066 | |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1067 | Retrieves a group member. |
| 1068 | |
| 1069 | .Request |
| 1070 | ---- |
| 1071 | GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/members/1000096 HTTP/1.0 |
| 1072 | ---- |
| 1073 | |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1074 | As response a detailed link:rest-api-accounts.html#account-info[ |
| 1075 | AccountInfo] entity is returned that describes the group member. |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1076 | |
| 1077 | .Response |
| 1078 | ---- |
| 1079 | HTTP/1.1 200 OK |
| 1080 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1081 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1082 | |
| 1083 | )]}' |
| 1084 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1085 | "_account_id": 1000096, |
| 1086 | "name": "John Doe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1087 | "email": "john.doe@example.com", |
| 1088 | "username": "john" |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1089 | } |
| 1090 | ---- |
| 1091 | |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1092 | [[add-group-member]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1093 | === Add Group Member |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1094 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1095 | 'PUT /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1096 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1097 | |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1098 | Adds a user as member to a Gerrit internal group. |
| 1099 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 1100 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 1101 | non-internal group will return 405 Method Not Allowed. |
| 1102 | |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1103 | .Request |
| 1104 | ---- |
| 1105 | PUT /groups/MyProject-Committers/members/John%20Doe HTTP/1.0 |
| 1106 | ---- |
| 1107 | |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1108 | As response a detailed link:rest-api-accounts.html#account-info[ |
| 1109 | AccountInfo] entity is returned that describes the group member. |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1110 | |
| 1111 | .Response |
| 1112 | ---- |
| 1113 | HTTP/1.1 201 Created |
| 1114 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1115 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1116 | |
| 1117 | )]}' |
| 1118 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1119 | "_account_id": 1000037, |
| 1120 | "name": "John Doe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1121 | "email": "john.doe@example.com", |
| 1122 | "username": "john" |
Edwin Kempin | a5d6ead | 2013-02-06 10:59:06 +0100 | [diff] [blame] | 1123 | } |
| 1124 | ---- |
| 1125 | |
| 1126 | The request also succeeds if the user is already a member of this |
| 1127 | group, but then the HTTP response code is `200 OK`. |
| 1128 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1129 | === Add Group Members |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1130 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1131 | 'POST /groups/link:#group-id[\{group-id\}]/members' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1132 | -- |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1133 | |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1134 | OR |
| 1135 | |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1136 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1137 | 'POST /groups/link:#group-id[\{group-id\}]/members.add' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1138 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1139 | |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1140 | Adds one or several users to a Gerrit internal group. |
| 1141 | |
| 1142 | The users to be added to the group must be provided in the request body |
Sasa Zivkov | 737e0a3 | 2013-03-18 14:21:42 +0100 | [diff] [blame] | 1143 | as a link:#members-input[MembersInput] entity. |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1144 | |
| 1145 | .Request |
| 1146 | ---- |
| 1147 | POST /groups/MyProject-Committers/members.add HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1148 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1149 | |
| 1150 | { |
Chris St. Pierre | b39fb9e | 2013-08-06 15:55:00 -0400 | [diff] [blame] | 1151 | "members": [ |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1152 | "jane.roe@example.com", |
| 1153 | "john.doe@example.com" |
Chris St. Pierre | b39fb9e | 2013-08-06 15:55:00 -0400 | [diff] [blame] | 1154 | ] |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1155 | } |
| 1156 | ---- |
| 1157 | |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1158 | As response a list of detailed link:rest-api-accounts.html#account-info[ |
| 1159 | AccountInfo] entities is returned that describes the group members that |
Sasa Zivkov | 737e0a3 | 2013-03-18 14:21:42 +0100 | [diff] [blame] | 1160 | were specified in the link:#members-input[MembersInput]. An |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1161 | link:rest-api-accounts.html#account-info[AccountInfo] entity |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1162 | is returned for each user specified in the input, independently of |
| 1163 | whether the user was newly added to the group or whether the user was |
| 1164 | already a member of the group. |
| 1165 | |
| 1166 | .Response |
| 1167 | ---- |
| 1168 | HTTP/1.1 200 OK |
| 1169 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1170 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1171 | |
| 1172 | )]}' |
| 1173 | [ |
| 1174 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1175 | "_account_id": 1000057, |
| 1176 | "name": "Jane Roe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1177 | "email": "jane.roe@example.com", |
| 1178 | "username": "jane" |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1179 | }, |
| 1180 | { |
Edwin Kempin | 963dfd0 | 2013-02-27 12:39:32 +0100 | [diff] [blame] | 1181 | "_account_id": 1000037, |
| 1182 | "name": "John Doe", |
James Ring | 8e34272 | 2013-05-01 01:40:53 -0700 | [diff] [blame] | 1183 | "email": "john.doe@example.com", |
| 1184 | "username": "john" |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1185 | } |
| 1186 | ] |
| 1187 | ---- |
| 1188 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1189 | [[remove-group-member]] |
| 1190 | === Remove Group Member |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1191 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1192 | 'DELETE /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1193 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1194 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1195 | Removes a user from a Gerrit internal group. |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1196 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 1197 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 1198 | non-internal group will return 405 Method Not Allowed. |
| 1199 | |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1200 | .Request |
| 1201 | ---- |
| 1202 | DELETE /groups/MyProject-Committers/members/John%20Doe HTTP/1.0 |
| 1203 | ---- |
| 1204 | |
| 1205 | .Response |
| 1206 | ---- |
| 1207 | HTTP/1.1 204 No Content |
| 1208 | ---- |
| 1209 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1210 | [[remove-group-members]] |
| 1211 | === Remove Group Members |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1212 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1213 | 'POST /groups/link:#group-id[\{group-id\}]/members.delete' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1214 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1215 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1216 | Removes one or several users from a Gerrit internal group. |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1217 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1218 | The users to be removed from the group must be provided in the request |
Sasa Zivkov | 737e0a3 | 2013-03-18 14:21:42 +0100 | [diff] [blame] | 1219 | body as a link:#members-input[MembersInput] entity. |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1220 | |
| 1221 | .Request |
| 1222 | ---- |
| 1223 | POST /groups/MyProject-Committers/members.delete HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1224 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1225 | |
| 1226 | { |
Chris St. Pierre | b39fb9e | 2013-08-06 15:55:00 -0400 | [diff] [blame] | 1227 | "members": [ |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1228 | "jane.roe@example.com", |
| 1229 | "john.doe@example.com" |
Chris St. Pierre | b39fb9e | 2013-08-06 15:55:00 -0400 | [diff] [blame] | 1230 | ] |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1231 | } |
| 1232 | ---- |
| 1233 | |
| 1234 | .Response |
| 1235 | ---- |
| 1236 | HTTP/1.1 204 No Content |
| 1237 | ---- |
| 1238 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1239 | [[subgroup-endpoints]] |
| 1240 | == Subgroup Endpoints |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1241 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1242 | [[list-subgroups]] |
| 1243 | === List Subgroups |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1244 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1245 | 'GET /groups/link:#group-id[\{group-id\}]/groups/' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1246 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1247 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1248 | Lists the direct subgroups of a group. |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1249 | |
| 1250 | As result a list of link:#group-info[GroupInfo] entries is returned. |
| 1251 | The entries in the list are sorted by group name and UUID. |
| 1252 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 1253 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 1254 | non-internal group will return 405 Method Not Allowed. |
| 1255 | |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1256 | .Request |
| 1257 | ---- |
| 1258 | GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/groups/ HTTP/1.0 |
| 1259 | ---- |
| 1260 | |
| 1261 | .Response |
| 1262 | ---- |
| 1263 | HTTP/1.1 200 OK |
| 1264 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1265 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1266 | |
| 1267 | )]}' |
| 1268 | [ |
| 1269 | { |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1270 | "id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 1271 | "name": "MyProject-Verifiers", |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 1272 | "url": "#/admin/groups/uuid-7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 1273 | "options": { |
Edwin Kempin | e05c964 | 2013-02-11 09:36:21 +0100 | [diff] [blame] | 1274 | }, |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1275 | "group_id": 38, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 1276 | "owner": "MyProject-Verifiers", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1277 | "owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 1278 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 578fff7 | 2013-02-11 08:08:27 +0100 | [diff] [blame] | 1279 | } |
| 1280 | ] |
| 1281 | ---- |
| 1282 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1283 | [[get-subgroup]] |
| 1284 | === Get Subgroup |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1285 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1286 | 'GET /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1287 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1288 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1289 | Retrieves a subgroup. |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1290 | |
| 1291 | .Request |
| 1292 | ---- |
| 1293 | GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/groups/7ca042f4d5847936fcb90ca91057673157fd06fc HTTP/1.0 |
| 1294 | ---- |
| 1295 | |
| 1296 | As response a link:#group-info[GroupInfo] entity is returned that |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1297 | describes the subgroup. |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1298 | |
| 1299 | .Response |
| 1300 | ---- |
| 1301 | HTTP/1.1 200 OK |
| 1302 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1303 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1304 | |
| 1305 | )]}' |
| 1306 | { |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1307 | "id": "7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 1308 | "name": "MyProject-Verifiers", |
| 1309 | "url": "#/admin/groups/uuid-7ca042f4d5847936fcb90ca91057673157fd06fc", |
| 1310 | "options": { |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1311 | }, |
| 1312 | "group_id": 38, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 1313 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1314 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1315 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | a5cc112 | 2013-02-11 09:26:20 +0100 | [diff] [blame] | 1316 | } |
| 1317 | ---- |
| 1318 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1319 | [[add-subgroup]] |
| 1320 | === Add Subgroup |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1321 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1322 | 'PUT /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1323 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1324 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1325 | Adds an internal or external group as subgroup to a Gerrit internal group. |
Dariusz Luksza | ccfa649 | 2013-06-07 11:07:38 +0200 | [diff] [blame] | 1326 | External groups must be specified using the UUID. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1327 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 1328 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 1329 | non-internal group will return 405 Method Not Allowed. |
| 1330 | |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1331 | .Request |
| 1332 | ---- |
| 1333 | PUT /groups/MyProject-Committers/groups/MyGroup HTTP/1.0 |
| 1334 | ---- |
| 1335 | |
| 1336 | As response a link:#group-info[GroupInfo] entity is returned that |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1337 | describes the subgroup. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1338 | |
| 1339 | .Response |
| 1340 | ---- |
| 1341 | HTTP/1.1 201 Created |
| 1342 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1343 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1344 | |
| 1345 | )]}' |
| 1346 | { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1347 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1348 | "name": "MyGroup", |
| 1349 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1350 | "options": { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1351 | }, |
| 1352 | "group_id": 8, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 1353 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1354 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1355 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1356 | } |
| 1357 | ---- |
| 1358 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1359 | The request also succeeds if the group is already a subgroup of this |
| 1360 | group. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1361 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1362 | [[add-subgroups]] |
| 1363 | === Add Subgroups |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1364 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1365 | 'POST /groups/link:#group-id[\{group-id\}]/groups' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1366 | -- |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1367 | |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1368 | OR |
| 1369 | |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1370 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1371 | 'POST /groups/link:#group-id[\{group-id\}]/groups.add' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1372 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1373 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1374 | Adds one or several groups as subgroups to a Gerrit internal group. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1375 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1376 | The subgroups to be added must be provided in the request body as a |
| 1377 | link:#groups-input[GroupsInput] entity. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1378 | |
| 1379 | .Request |
| 1380 | ---- |
| 1381 | POST /groups/MyProject-Committers/groups.add HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1382 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1383 | |
| 1384 | { |
Dave Borowitz | d2b9217 | 2014-04-01 11:15:18 -0700 | [diff] [blame] | 1385 | "groups": [ |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1386 | "MyGroup", |
| 1387 | "MyOtherGroup" |
Dave Borowitz | d2b9217 | 2014-04-01 11:15:18 -0700 | [diff] [blame] | 1388 | ] |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1389 | } |
| 1390 | ---- |
| 1391 | |
| 1392 | As response a list of link:#group-info[GroupInfo] entities is |
| 1393 | returned that describes the groups that were specified in the |
| 1394 | link:#groups-input[GroupsInput]. A link:#group-info[GroupInfo] entity |
| 1395 | is returned for each group specified in the input, independently of |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1396 | whether the group was newly added as subgroup or whether the |
| 1397 | group was already a subgroup of the group. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1398 | |
| 1399 | .Response |
| 1400 | ---- |
| 1401 | HTTP/1.1 200 OK |
| 1402 | Content-Disposition: attachment |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1403 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1404 | |
| 1405 | )]}' |
| 1406 | [ |
| 1407 | { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1408 | "id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1409 | "name": "MyGroup", |
| 1410 | "url": "#/admin/groups/uuid-6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1411 | "options": { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1412 | }, |
| 1413 | "group_id": 8, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 1414 | "owner": "Administrators", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1415 | "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389", |
| 1416 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1417 | }, |
| 1418 | { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1419 | "id": "5057f3cbd3519d6ab69364429a89ffdffba50f73", |
| 1420 | "name": "MyOtherGroup", |
| 1421 | "url": "#/admin/groups/uuid-5057f3cbd3519d6ab69364429a89ffdffba50f73", |
| 1422 | "options": { |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1423 | }, |
| 1424 | "group_id": 10, |
Edwin Kempin | c6993fb | 2013-02-11 12:39:13 +0100 | [diff] [blame] | 1425 | "owner": "MyOtherGroup", |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1426 | "owner_id": "5057f3cbd3519d6ab69364429a89ffdffba50f73", |
| 1427 | "created_on": "2013-02-01 09:59:32.126000000" |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1428 | } |
| 1429 | ] |
| 1430 | ---- |
| 1431 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1432 | [[remove-subgroup]] |
| 1433 | === Remove Subgroup |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1434 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1435 | 'DELETE /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1436 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1437 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1438 | Removes a subgroup from a Gerrit internal group. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1439 | |
Dave Borowitz | bf5efd5 | 2018-02-06 09:52:42 -0500 | [diff] [blame] | 1440 | This endpoint is only allowed for Gerrit internal groups; attempting to call on a |
| 1441 | non-internal group will return 405 Method Not Allowed. |
| 1442 | |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1443 | .Request |
| 1444 | ---- |
| 1445 | DELETE /groups/MyProject-Committers/groups/MyGroup HTTP/1.0 |
| 1446 | ---- |
| 1447 | |
| 1448 | .Response |
| 1449 | ---- |
| 1450 | HTTP/1.1 204 No Content |
| 1451 | ---- |
| 1452 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1453 | [[remove-subgroups]] |
| 1454 | === Remove Subgroups |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1455 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1456 | 'POST /groups/link:#group-id[\{group-id\}]/groups.delete' |
Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 1457 | -- |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1458 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1459 | Removes one or several subgroups from a Gerrit internal group. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1460 | |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1461 | The subgroups to be removed must be provided in the request body as a |
| 1462 | link:#groups-input[GroupsInput] entity. |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1463 | |
| 1464 | .Request |
| 1465 | ---- |
| 1466 | POST /groups/MyProject-Committers/groups.delete HTTP/1.0 |
David Pursehouse | 56bf1cb | 2015-01-06 15:44:00 +0900 | [diff] [blame] | 1467 | Content-Type: application/json; charset=UTF-8 |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1468 | |
| 1469 | { |
Edwin Kempin | 4b77e60 | 2014-04-18 08:54:36 +0200 | [diff] [blame] | 1470 | "groups": [ |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1471 | "MyGroup", |
| 1472 | "MyOtherGroup" |
Dave Borowitz | d2b9217 | 2014-04-01 11:15:18 -0700 | [diff] [blame] | 1473 | ] |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1474 | } |
| 1475 | ---- |
| 1476 | |
| 1477 | .Response |
| 1478 | ---- |
| 1479 | HTTP/1.1 204 No Content |
| 1480 | ---- |
| 1481 | |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1482 | |
Edwin Kempin | 34d8335 | 2013-02-06 10:40:17 +0100 | [diff] [blame] | 1483 | [[ids]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1484 | == IDs |
Edwin Kempin | 34d8335 | 2013-02-06 10:40:17 +0100 | [diff] [blame] | 1485 | |
Edwin Kempin | 2689e3d | 2013-02-07 15:52:36 +0100 | [diff] [blame] | 1486 | [[group-id]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1487 | === \{group-id\} |
Edwin Kempin | 34d8335 | 2013-02-06 10:40:17 +0100 | [diff] [blame] | 1488 | Identifier for a group. |
| 1489 | |
| 1490 | This can be: |
| 1491 | |
| 1492 | * the UUID of the group |
| 1493 | * the legacy numeric ID of the group |
| 1494 | * the name of the group if it is unique |
| 1495 | |
Edwin Kempin | 50d3d9b | 2013-03-06 16:38:26 +0100 | [diff] [blame] | 1496 | [[group-name]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1497 | === \{group-name\} |
Edwin Kempin | 34d8335 | 2013-02-06 10:40:17 +0100 | [diff] [blame] | 1498 | Group name that uniquely identifies one group. |
| 1499 | |
| 1500 | |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1501 | [[json-entities]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1502 | == JSON Entities |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1503 | |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 1504 | [[group-audit-event-info]] |
| 1505 | === GroupAuditEventInfo |
| 1506 | The `GroupAuditEventInfo` entity contains information about an audit |
| 1507 | event of a group. |
| 1508 | |
| 1509 | [options="header",cols="1,6"] |
| 1510 | |====================== |
| 1511 | |Field Name|Description |
| 1512 | |`member` | |
| 1513 | The group member that is added/removed. If `type` is `ADD_USER` or |
| 1514 | `REMOVE_USER` the member is returned as detailed |
| 1515 | link:rest-api-accounts.html#account-info[AccountInfo] entity, if `type` |
| 1516 | is `ADD_GROUP` or `REMOVE_GROUP` the member is returned as |
Changcheng Xiao | 219e3c5 | 2018-02-27 09:53:37 +0100 | [diff] [blame] | 1517 | link:#group-info[GroupInfo] entity. Note that the `name` in |
| 1518 | link:#group-info[GroupInfo] will not be set if the member group is not |
| 1519 | available. |
Edwin Kempin | fc3f832 | 2015-07-03 13:34:19 +0200 | [diff] [blame] | 1520 | |`type` | |
| 1521 | The event type, can be: `ADD_USER`, `REMOVE_USER`, `ADD_GROUP` or |
| 1522 | `REMOVE_GROUP`. |
| 1523 | |
| 1524 | `ADD_USER`: A user was added as member to the group. |
| 1525 | |
| 1526 | `REMOVE_USER`: A user member was removed from the group. |
| 1527 | |
| 1528 | `ADD_GROUP`: A group was included as member in the group. |
| 1529 | |
| 1530 | `REMOVE_GROUP`: An included group was removed from the group. |
| 1531 | |`user` | |
| 1532 | The user that did the add/remove as detailed |
| 1533 | link:rest-api-accounts.html#account-info[AccountInfo] entity. |
| 1534 | |`date` | |
| 1535 | The timestamp of the event. |
| 1536 | |====================== |
| 1537 | |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1538 | [[group-info]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1539 | === GroupInfo |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1540 | The `GroupInfo` entity contains information about a group. This can be |
| 1541 | a Gerrit internal group, or an external group that is known to Gerrit. |
| 1542 | |
David Pursehouse | ae36719 | 2014-11-25 17:24:47 +0900 | [diff] [blame] | 1543 | [options="header",cols="1,^1,5"] |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1544 | |=========================== |
| 1545 | |Field Name ||Description |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1546 | |`id` ||The URL encoded UUID of the group. |
Edwin Kempin | 5b591d1 | 2013-03-08 09:18:35 +0100 | [diff] [blame] | 1547 | |`name` | |
Edwin Kempin | 219e797 | 2018-03-27 09:24:54 +0200 | [diff] [blame] | 1548 | optional, not set if returned in a map where the group name is used as map key| |
| 1549 | The name of the group. + |
| 1550 | For external groups the group name is missing if there is no group |
| 1551 | backend that can resolve the group UUID. E.g. this can happen when a |
| 1552 | plugin that provided a group backend was uninstalled. |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1553 | |`url` |optional| |
| 1554 | URL to information about the group. Typically a URL to a web page that |
| 1555 | permits users to apply to join the group, or manage their membership. |
| 1556 | |`options` ||link:#group-options-info[Options of the group] |
| 1557 | |`description` |only for internal groups|The description of the group. |
| 1558 | |`group_id` |only for internal groups|The numeric ID of the group. |
Edwin Kempin | 6a628e1 | 2017-11-13 11:13:27 +0100 | [diff] [blame] | 1559 | |`owner` |only for internal groups|The name of the owner group. |
| 1560 | |`owner_id` |only for internal groups|The URL encoded UUID of the owner group. |
Alice Kober-Sotzek | 2324927 | 2017-06-23 10:29:32 +0200 | [diff] [blame] | 1561 | |`created_on` |only for internal groups|The |
| 1562 | link:rest-api.html#timestamp[timestamp] of when the group was created. |
Edwin Kempin | fadf363 | 2017-01-03 15:16:17 +0100 | [diff] [blame] | 1563 | |`_more_groups`|optional, only for internal groups, not set if `false`| |
| 1564 | Whether the query would deliver more results if not limited. + |
| 1565 | Only set on the last group that is returned by a |
| 1566 | link:#query-groups[group query]. |
Edwin Kempin | abaab546 | 2013-02-11 15:30:19 +0100 | [diff] [blame] | 1567 | |`members` |optional, only for internal groups| |
| 1568 | A list of link:rest-api-accounts.html#account-info[AccountInfo] |
| 1569 | entities describing the direct members. + |
| 1570 | Only set if link:#members[members] are requested. |
| 1571 | |`includes` |optional, only for internal groups| |
Alice Kober-Sotzek | 8a9d8a4 | 2017-08-23 16:47:46 +0200 | [diff] [blame] | 1572 | A list of link:#group-info[GroupInfo] entities describing the direct |
| 1573 | subgroups. + |
| 1574 | Only set if link:#includes[subgroups] are requested. |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1575 | |=========================== |
| 1576 | |
Edwin Kempin | c42abb9 | 2013-02-04 14:52:41 +0100 | [diff] [blame] | 1577 | The type of a group can be deduced from the group's UUID: |
Edwin Kempin | c42abb9 | 2013-02-04 14:52:41 +0100 | [diff] [blame] | 1578 | |============ |
| 1579 | |UUID matches "^[0-9a-f]\{40\}$"|Gerrit internal group |
| 1580 | |UUID starts with "global:"|Gerrit system group |
| 1581 | |UUID starts with "ldap:"|LDAP group |
| 1582 | |UUID starts with "<prefix>:"|other external group |
| 1583 | |============ |
| 1584 | |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1585 | [[group-input]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1586 | === GroupInput |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1587 | The 'GroupInput' entity contains information for the creation of |
| 1588 | a new internal group. |
| 1589 | |
David Pursehouse | ae36719 | 2014-11-25 17:24:47 +0900 | [diff] [blame] | 1590 | [options="header",cols="1,^1,5"] |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1591 | |=========================== |
| 1592 | |Field Name ||Description |
| 1593 | |`name` |optional|The name of the group (not encoded). + |
| 1594 | If set, must match the group name in the URL. |
David Pursehouse | 666b34d | 2019-09-09 09:08:56 +0900 | [diff] [blame] | 1595 | |`uuid` |optional|The UUID of the group. |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1596 | |`description` |optional|The description of the group. |
| 1597 | |`visible_to_all`|optional| |
| 1598 | Whether the group is visible to all registered users. + |
| 1599 | `false` if not set. |
Yuxuan 'fishy' Wang | 578eb50 | 2016-08-12 12:02:55 -0700 | [diff] [blame] | 1600 | |`owner_id` |optional|The URL encoded ID of the owner group. + |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1601 | This can be a group UUID, a legacy numeric group ID or a unique group |
| 1602 | name. + |
| 1603 | If not set, the new group will be self-owned. |
Yuxuan 'fishy' Wang | 578eb50 | 2016-08-12 12:02:55 -0700 | [diff] [blame] | 1604 | |`members` |optional|The initial members in a list of + |
Edwin Kempin | c6d615a | 2016-12-01 14:49:31 +0100 | [diff] [blame] | 1605 | link:rest-api-accounts.html#account-id[account ids]. |
Edwin Kempin | aa266ff | 2013-02-05 12:41:09 +0100 | [diff] [blame] | 1606 | |=========================== |
| 1607 | |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1608 | [[group-options-info]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1609 | === GroupOptionsInfo |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1610 | Options of the group. |
| 1611 | |
David Pursehouse | ae36719 | 2014-11-25 17:24:47 +0900 | [diff] [blame] | 1612 | [options="header",cols="1,^1,5"] |
Edwin Kempin | f04fc9c | 2013-02-05 14:09:45 +0100 | [diff] [blame] | 1613 | |============================= |
| 1614 | |Field Name ||Description |
Edwin Kempin | f04fc9c | 2013-02-05 14:09:45 +0100 | [diff] [blame] | 1615 | |`visible_to_all`|not set if `false`| |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1616 | Whether the group is visible to all registered users. |
Edwin Kempin | f04fc9c | 2013-02-05 14:09:45 +0100 | [diff] [blame] | 1617 | |============================= |
Edwin Kempin | 987d543 | 2013-02-04 10:20:44 +0100 | [diff] [blame] | 1618 | |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 1619 | [[group-options-input]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1620 | === GroupOptionsInput |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 1621 | New options for a group. |
| 1622 | |
David Pursehouse | ae36719 | 2014-11-25 17:24:47 +0900 | [diff] [blame] | 1623 | [options="header",cols="1,^1,5"] |
Edwin Kempin | 1461c22 | 2013-02-11 08:41:08 +0100 | [diff] [blame] | 1624 | |============================= |
| 1625 | |Field Name ||Description |
| 1626 | |`visible_to_all`|not set if `false`| |
| 1627 | Whether the group is visible to all registered users. |
| 1628 | |============================= |
| 1629 | |
Edwin Kempin | 521c124 | 2015-01-23 12:44:44 +0100 | [diff] [blame] | 1630 | [[groups-input]] |
| 1631 | === GroupsInput |
| 1632 | The `GroupsInput` entity contains information about groups that should |
| 1633 | be included into a group or that should be deleted from a group. |
| 1634 | |
| 1635 | [options="header",cols="1,^1,5"] |
| 1636 | |========================== |
| 1637 | |Field Name ||Description |
| 1638 | |`_one_group` |optional| |
| 1639 | The link:#group-id[id] of one group that should be included or deleted. |
| 1640 | |`groups` |optional| |
| 1641 | A list of link:#group-id[group ids] that identify the groups that |
| 1642 | should be included or deleted. |
| 1643 | |========================== |
| 1644 | |
Sasa Zivkov | 737e0a3 | 2013-03-18 14:21:42 +0100 | [diff] [blame] | 1645 | [[members-input]] |
David Pursehouse | b10c266 | 2016-12-06 08:41:33 +0900 | [diff] [blame] | 1646 | === MembersInput |
Sasa Zivkov | 737e0a3 | 2013-03-18 14:21:42 +0100 | [diff] [blame] | 1647 | The `MembersInput` entity contains information about accounts that should |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1648 | be added as members to a group or that should be deleted from the group. |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1649 | |
David Pursehouse | ae36719 | 2014-11-25 17:24:47 +0900 | [diff] [blame] | 1650 | [options="header",cols="1,^1,5"] |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1651 | |========================== |
| 1652 | |Field Name ||Description |
| 1653 | |`_one_member`|optional| |
Edwin Kempin | c6d615a | 2016-12-01 14:49:31 +0100 | [diff] [blame] | 1654 | The link:rest-api-accounts.html#account-id[id] of one account that |
Edwin Kempin | acbdfd3 | 2013-02-07 12:38:53 +0100 | [diff] [blame] | 1655 | should be added or deleted. |
Edwin Kempin | c6d615a | 2016-12-01 14:49:31 +0100 | [diff] [blame] | 1656 | |`members` |optional| |
| 1657 | A list of link:rest-api-accounts.html#account-id[account ids] that |
| 1658 | identify the accounts that should be added or deleted. |
Edwin Kempin | 2cdef5f | 2013-02-06 16:50:15 +0100 | [diff] [blame] | 1659 | |========================== |
| 1660 | |
| 1661 | |
Edwin Kempin | d0a6392 | 2013-01-23 16:32:59 +0100 | [diff] [blame] | 1662 | GERRIT |
| 1663 | ------ |
| 1664 | Part of link:index.html[Gerrit Code Review] |
Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 1665 | |
| 1666 | SEARCHBOX |
| 1667 | --------- |