Mercurial > public > src > rhodecode
annotate docs/api/api.rst @ 2249:12ceeda33339 beta
#404 API extensions for showing permission for users
- added permissions to get_user function
- added last_login to get_user and get_users function
- modified custom JSON encoder to handle non standard python types, like set, OrderedDict, datetime, date
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Wed, 21 Mar 2012 21:00:55 +0200 |
| parents | ee45677c4edc |
| children | dc2584ba5fbc 347b00545b60 |
| rev | line source |
|---|---|
| 1526 | 1 .. _api: |
| 2 | |
| 2191 | 3 === |
| 1526 | 4 API |
| 5 === | |
| 6 | |
| 7 | |
| 8 Starting from RhodeCode version 1.2 a simple API was implemented. | |
| 1580 | 9 There's a single schema for calling all api methods. API is implemented |
| 1676 | 10 with JSON protocol both ways. An url to send API request in RhodeCode is |
| 1580 | 11 <your_server>/_admin/api |
| 1526 | 12 |
| 1924 | 13 API ACCESS FOR WEB VIEWS |
| 14 ++++++++++++++++++++++++ | |
| 1526 | 15 |
| 1996 | 16 API access can also be turned on for each web view in RhodeCode that is |
| 17 decorated with `@LoginRequired` decorator. To enable API access simple change | |
| 18 the standard login decorator to `@LoginRequired(api_access=True)`. | |
| 19 After this change, a rhodecode view can be accessed without login by adding a | |
| 20 GET parameter `?api_key=<api_key>` to url. By default this is only | |
|
1896
320dec24fb9a
Added instruction on enabling the API access to web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1895
diff
changeset
|
21 enabled on RSS/ATOM feed views. |
|
320dec24fb9a
Added instruction on enabling the API access to web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1895
diff
changeset
|
22 |
|
320dec24fb9a
Added instruction on enabling the API access to web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1895
diff
changeset
|
23 |
| 1924 | 24 API ACCESS |
| 25 ++++++++++ | |
| 26 | |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
27 All clients are required to send JSON-RPC spec JSON data:: |
| 1526 | 28 |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
29 { |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
30 "id:"<id>", |
| 1526 | 31 "api_key":"<api_key>", |
| 32 "method":"<method_name>", | |
| 33 "args":{"<arg_key>":"<arg_val>"} | |
| 34 } | |
| 35 | |
| 1580 | 36 Example call for autopulling remotes repos using curl:: |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
37 curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}' |
| 1580 | 38 |
| 1676 | 39 Simply provide |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
40 - *id* A value of any type, which is used to match the response with the request that it is replying to. |
| 1580 | 41 - *api_key* for access and permission validation. |
| 42 - *method* is name of method to call | |
| 43 - *args* is an key:value list of arguments to pass to method | |
| 1676 | 44 |
| 1526 | 45 .. note:: |
| 1676 | 46 |
| 47 api_key can be found in your user account page | |
| 48 | |
| 49 | |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
50 RhodeCode API will return always a JSON-RPC response:: |
| 1676 | 51 |
|
1793
fee9895fa46e
changed API to match fully JSON-RPC specs
Marcin Kuzminski <marcin@python-works.com>
parents:
1676
diff
changeset
|
52 { |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
53 "id":<id>, # matching id sent by request |
|
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
54 "result": "<result>"|null, # JSON formatted result, null if any errors |
|
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
55 "error": "null"|<error_message> # JSON formatted error (if any) |
| 1526 | 56 } |
| 57 | |
| 58 All responses from API will be `HTTP/1.0 200 OK`, if there's an error while | |
| 1676 | 59 calling api *error* key from response will contain failure description |
| 1526 | 60 and result will be null. |
| 61 | |
| 62 API METHODS | |
| 63 +++++++++++ | |
| 64 | |
| 1676 | 65 |
| 1526 | 66 pull |
| 67 ---- | |
| 68 | |
| 1676 | 69 Pulls given repo from remote location. Can be used to automatically keep |
| 70 remote repos up to date. This command can be executed only using api_key | |
| 1580 | 71 belonging to user with admin rights |
| 72 | |
| 73 INPUT:: | |
| 74 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
75 id : <id_for_response> |
| 1676 | 76 api_key : "<api_key>" |
| 77 method : "pull" | |
| 78 args : { | |
| 1928 | 79 "repo_name" : "<reponame>" |
| 1676 | 80 } |
| 81 | |
| 82 OUTPUT:: | |
| 83 | |
| 1928 | 84 result : "Pulled from <reponame>" |
| 1676 | 85 error : null |
| 86 | |
| 87 | |
| 1928 | 88 get_user |
| 89 -------- | |
| 90 | |
|
2098
14dffcfebb02
API get_user and get_repo methods can fetch by id or names
Marcin Kuzminski <marcin@python-works.com>
parents:
2097
diff
changeset
|
91 Get's an user by username or user_id, Returns empty result if user is not found. |
| 1928 | 92 This command can be executed only using api_key belonging to user with admin |
| 93 rights. | |
| 94 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
95 |
| 1928 | 96 INPUT:: |
| 97 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
98 id : <id_for_response> |
| 1928 | 99 api_key : "<api_key>" |
| 100 method : "get_user" | |
| 101 args : { | |
|
2098
14dffcfebb02
API get_user and get_repo methods can fetch by id or names
Marcin Kuzminski <marcin@python-works.com>
parents:
2097
diff
changeset
|
102 "userid" : "<username or user_id>" |
| 1928 | 103 } |
| 104 | |
| 105 OUTPUT:: | |
| 106 | |
| 107 result: None if user does not exist or | |
| 108 { | |
| 109 "id" : "<id>", | |
| 110 "username" : "<username>", | |
| 111 "firstname": "<firstname>", | |
| 112 "lastname" : "<lastname>", | |
| 113 "email" : "<email>", | |
| 114 "active" : "<bool>", | |
| 115 "admin" :Â "<bool>", | |
|
2249
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
116 "ldap_dn" : "<ldap_dn>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
117 "last_login": "<last_login>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
118 "permissions": { |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
119 "global": ["hg.create.repository", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
120 "repository.read", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
121 "hg.register.manual_activate"], |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
122 "repositories": {"repo1": "repository.none"}, |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
123 "repositories_groups": {"Group1": "group.read"} |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
124 }, |
| 1928 | 125 } |
| 126 | |
| 127 error: null | |
| 128 | |
| 129 | |
| 1676 | 130 get_users |
| 131 --------- | |
| 132 | |
| 133 Lists all existing users. This command can be executed only using api_key | |
| 134 belonging to user with admin rights. | |
| 135 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
136 |
| 1676 | 137 INPUT:: |
| 138 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
139 id : <id_for_response> |
| 1676 | 140 api_key : "<api_key>" |
| 141 method : "get_users" | |
| 142 args : { } | |
| 143 | |
| 144 OUTPUT:: | |
| 145 | |
| 146 result: [ | |
| 147 { | |
| 148 "id" : "<id>", | |
| 149 "username" : "<username>", | |
| 150 "firstname": "<firstname>", | |
| 151 "lastname" : "<lastname>", | |
| 152 "email" : "<email>", | |
| 153 "active" : "<bool>", | |
| 154 "admin" :Â "<bool>", | |
|
2249
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
155 "ldap_dn" : "<ldap_dn>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
156 "last_login": "<last_login>", |
| 1676 | 157 }, |
| 158 … | |
| 159 ] | |
| 160 error: null | |
| 161 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
162 |
| 1676 | 163 create_user |
| 164 ----------- | |
| 165 | |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
166 Creates new user. This command can |
|
1994
f2bd5b0c1094
create user api_doc update
Marcin Kuzminski <marcin@python-works.com>
parents:
1928
diff
changeset
|
167 be executed only using api_key belonging to user with admin rights. |
| 1676 | 168 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
169 |
| 1676 | 170 INPUT:: |
| 171 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
172 id : <id_for_response> |
| 1676 | 173 api_key : "<api_key>" |
| 174 method : "create_user" | |
| 175 args : { | |
| 176 "username" : "<username>", | |
| 177 "password" : "<password>", | |
|
2036
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
178 "email" : "<useremail>", |
|
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
179 "firstname" : "<firstname> = None", |
|
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
180 "lastname" : "<lastname> = None", |
| 1676 | 181 "active" : "<bool> = True", |
| 182 "admin" : "<bool> = False", | |
| 183 "ldap_dn" : "<ldap_dn> = None" | |
| 184 } | |
| 1580 | 185 |
| 186 OUTPUT:: | |
| 187 | |
| 1676 | 188 result: { |
| 1928 | 189 "id" : "<new_user_id>", |
| 1676 | 190 "msg" : "created new user <username>" |
| 191 } | |
| 192 error: null | |
| 193 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
194 |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
195 update_user |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
196 ----------- |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
197 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
198 updates current one if such user exists. This command can |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
199 be executed only using api_key belonging to user with admin rights. |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
200 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
201 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
202 INPUT:: |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
203 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
204 id : <id_for_response> |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
205 api_key : "<api_key>" |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
206 method : "update_user" |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
207 args : { |
| 2097 | 208 "userid" : "<user_id or username>", |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
209 "username" : "<username>", |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
210 "password" : "<password>", |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
211 "email" : "<useremail>", |
| 2097 | 212 "firstname" : "<firstname>", |
| 213 "lastname" : "<lastname>", | |
| 214 "active" : "<bool>", | |
| 215 "admin" : "<bool>", | |
| 216 "ldap_dn" : "<ldap_dn>" | |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
217 } |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
218 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
219 OUTPUT:: |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
220 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
221 result: { |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
222 "id" : "<edited_user_id>", |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
223 "msg" : "updated user <username>" |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
224 } |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
225 error: null |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
226 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
227 |
| 1676 | 228 get_users_group |
| 229 --------------- | |
| 230 | |
| 231 Gets an existing users group. This command can be executed only using api_key | |
| 232 belonging to user with admin rights. | |
| 233 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
234 |
| 1676 | 235 INPUT:: |
| 236 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
237 id : <id_for_response> |
| 1676 | 238 api_key : "<api_key>" |
| 239 method : "get_users_group" | |
| 240 args : { | |
| 241 "group_name" : "<name>" | |
| 242 } | |
| 243 | |
| 244 OUTPUT:: | |
| 245 | |
| 246 result : None if group not exist | |
| 247 { | |
| 1928 | 248 "id" : "<id>", |
| 249 "group_name" : "<groupname>", | |
| 250 "active": "<bool>", | |
| 1676 | 251 "members" : [ |
| 1928 | 252 { "id" : "<userid>", |
| 253 "username" : "<username>", | |
| 254 "firstname": "<firstname>", | |
| 255 "lastname" : "<lastname>", | |
| 256 "email" : "<email>", | |
| 257 "active" : "<bool>", | |
| 258 "admin" :Â "<bool>", | |
| 259 "ldap" : "<ldap_dn>" | |
| 260 }, | |
| 261 … | |
| 262 ] | |
| 1676 | 263 } |
| 264 error : null | |
| 265 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
266 |
| 1928 | 267 get_users_groups |
| 268 ---------------- | |
| 269 | |
| 270 Lists all existing users groups. This command can be executed only using | |
| 271 api_key belonging to user with admin rights. | |
| 272 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
273 |
| 1928 | 274 INPUT:: |
| 275 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
276 id : <id_for_response> |
| 1928 | 277 api_key : "<api_key>" |
| 278 method : "get_users_groups" | |
| 279 args : { } | |
| 280 | |
| 281 OUTPUT:: | |
| 282 | |
| 283 result : [ | |
| 284 { | |
| 285 "id" : "<id>", | |
| 286 "group_name" : "<groupname>", | |
| 287 "active": "<bool>", | |
| 288 "members" : [ | |
| 289 { | |
| 290 "id" : "<userid>", | |
| 291 "username" : "<username>", | |
| 292 "firstname": "<firstname>", | |
| 293 "lastname" : "<lastname>", | |
| 294 "email" : "<email>", | |
| 295 "active" : "<bool>", | |
| 296 "admin" :Â "<bool>", | |
| 297 "ldap" : "<ldap_dn>" | |
| 298 }, | |
| 299 … | |
| 300 ] | |
| 301 } | |
| 302 ] | |
| 303 error : null | |
| 304 | |
| 305 | |
| 1580 | 306 create_users_group |
| 307 ------------------ | |
| 308 | |
| 1676 | 309 Creates new users group. This command can be executed only using api_key |
| 1580 | 310 belonging to user with admin rights |
| 311 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
312 |
| 1580 | 313 INPUT:: |
| 314 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
315 id : <id_for_response> |
| 1676 | 316 api_key : "<api_key>" |
| 317 method : "create_users_group" | |
| 318 args: { | |
| 1928 | 319 "group_name": "<groupname>", |
| 1676 | 320 "active":"<bool> = True" |
| 321 } | |
| 322 | |
| 323 OUTPUT:: | |
| 324 | |
| 325 result: { | |
| 326 "id": "<newusersgroupid>", | |
| 1928 | 327 "msg": "created new users group <groupname>" |
| 1676 | 328 } |
| 329 error: null | |
| 330 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
331 |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
332 add_user_to_users_group |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
333 ----------------------- |
| 1676 | 334 |
| 2077 | 335 Adds a user to a users group. If user exists in that group success will be |
| 336 `false`. This command can be executed only using api_key | |
| 1676 | 337 belonging to user with admin rights |
| 338 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
339 |
| 1676 | 340 INPUT:: |
| 341 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
342 id : <id_for_response> |
| 1676 | 343 api_key : "<api_key>" |
| 344 method : "add_user_users_group" | |
| 345 args: { | |
| 346 "group_name" : "<groupname>", | |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
347 "username" : "<username>" |
| 1676 | 348 } |
| 349 | |
| 350 OUTPUT:: | |
| 351 | |
| 352 result: { | |
| 353 "id": "<newusersgroupmemberid>", | |
| 2077 | 354 "success": True|False # depends on if member is in group |
| 355 "msg": "added member <username> to users group <groupname> | | |
| 356 User is already in that group" | |
| 357 } | |
| 358 error: null | |
| 359 | |
| 360 | |
| 361 remove_user_from_users_group | |
| 362 ---------------------------- | |
| 363 | |
| 364 Removes a user from a users group. If user is not in given group success will | |
| 365 be `false`. This command can be executed only | |
| 366 using api_key belonging to user with admin rights | |
| 367 | |
| 368 | |
| 369 INPUT:: | |
| 370 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
371 id : <id_for_response> |
| 2077 | 372 api_key : "<api_key>" |
| 373 method : "remove_user_from_users_group" | |
| 374 args: { | |
| 375 "group_name" : "<groupname>", | |
| 376 "username" : "<username>" | |
| 377 } | |
| 378 | |
| 379 OUTPUT:: | |
| 380 | |
| 381 result: { | |
| 382 "success": True|False, # depends on if member is in group | |
| 383 "msg": "removed member <username> from users group <groupname> | | |
| 384 User wasn't in group" | |
| 1676 | 385 } |
| 386 error: null | |
| 387 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
388 |
| 1928 | 389 get_repo |
| 390 -------- | |
| 391 | |
| 2244 | 392 Gets an existing repository by it's name or repository_id. Members will return |
| 393 either users_group or user associated to that repository. This command can | |
|
2098
14dffcfebb02
API get_user and get_repo methods can fetch by id or names
Marcin Kuzminski <marcin@python-works.com>
parents:
2097
diff
changeset
|
394 be executed only using api_key belonging to user with admin rights. |
| 1928 | 395 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
396 |
| 1928 | 397 INPUT:: |
| 398 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
399 id : <id_for_response> |
| 1928 | 400 api_key : "<api_key>" |
| 401 method : "get_repo" | |
| 402 args: { | |
|
2098
14dffcfebb02
API get_user and get_repo methods can fetch by id or names
Marcin Kuzminski <marcin@python-works.com>
parents:
2097
diff
changeset
|
403 "repoid" : "<reponame or repo_id>" |
| 1928 | 404 } |
| 405 | |
| 406 OUTPUT:: | |
| 407 | |
| 408 result: None if repository does not exist or | |
| 409 { | |
| 410 "id" : "<id>", | |
| 411 "repo_name" : "<reponame>" | |
| 412 "type" : "<type>", | |
| 413 "description" : "<description>", | |
| 414 "members" : [ | |
| 2244 | 415 { |
| 416 "type": "user", | |
| 417 "id" : "<userid>", | |
| 1928 | 418 "username" : "<username>", |
| 419 "firstname": "<firstname>", | |
| 420 "lastname" : "<lastname>", | |
| 421 "email" : "<email>", | |
| 422 "active" : "<bool>", | |
| 423 "admin" :Â "<bool>", | |
| 424 "ldap" : "<ldap_dn>", | |
| 425 "permission" : "repository.(read|write|admin)" | |
| 426 }, | |
| 427 … | |
| 2244 | 428 { |
| 429 "type": "users_group", | |
| 1928 | 430 "id" : "<usersgroupid>", |
| 431 "name" : "<usersgroupname>", | |
| 432 "active": "<bool>", | |
| 433 "permission" : "repository.(read|write|admin)" | |
| 434 }, | |
| 435 … | |
| 436 ] | |
| 437 } | |
| 438 error: null | |
| 439 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
440 |
| 1676 | 441 get_repos |
| 442 --------- | |
| 443 | |
| 444 Lists all existing repositories. This command can be executed only using api_key | |
| 445 belonging to user with admin rights | |
| 446 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
447 |
| 1676 | 448 INPUT:: |
| 449 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
450 id : <id_for_response> |
| 1676 | 451 api_key : "<api_key>" |
| 452 method : "get_repos" | |
| 453 args: { } | |
| 1580 | 454 |
| 455 OUTPUT:: | |
| 456 | |
| 1676 | 457 result: [ |
| 458 { | |
| 459 "id" : "<id>", | |
| 1928 | 460 "repo_name" : "<reponame>" |
| 1676 | 461 "type" : "<type>", |
| 462 "description" : "<description>" | |
| 463 }, | |
| 464 … | |
| 465 ] | |
| 466 error: null | |
| 467 | |
| 468 | |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
469 get_repo_nodes |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
470 -------------- |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
471 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
472 returns a list of nodes and it's children in a flat list for a given path |
| 1928 | 473 at given revision. It's possible to specify ret_type to show only `files` or |
| 474 `dirs`. This command can be executed only using api_key belonging to user | |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
475 with admin rights |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
476 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
477 |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
478 INPUT:: |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
479 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
480 id : <id_for_response> |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
481 api_key : "<api_key>" |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
482 method : "get_repo_nodes" |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
483 args: { |
| 1928 | 484 "repo_name" : "<reponame>", |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
485 "revision" : "<revision>", |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
486 "root_path" : "<root_path>", |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
487 "ret_type" : "<ret_type>" = 'all' |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
488 } |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
489 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
490 OUTPUT:: |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
491 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
492 result: [ |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
493 { |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
494 "name" : "<name>" |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
495 "type" : "<type>", |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
496 }, |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
497 … |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
498 ] |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
499 error: null |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
500 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
501 |
| 1676 | 502 create_repo |
| 503 ----------- | |
| 504 | |
| 505 Creates a repository. This command can be executed only using api_key | |
| 506 belonging to user with admin rights. | |
| 507 If repository name contains "/", all needed repository groups will be created. | |
| 508 For example "foo/bar/baz" will create groups "foo", "bar" (with "foo" as parent), | |
| 509 and create "baz" repository with "bar" as group. | |
| 510 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
511 |
| 1676 | 512 INPUT:: |
| 513 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
514 id : <id_for_response> |
| 1676 | 515 api_key : "<api_key>" |
| 516 method : "create_repo" | |
| 517 args: { | |
| 1928 | 518 "repo_name" : "<reponame>", |
| 1676 | 519 "owner_name" : "<ownername>", |
| 520 "description" : "<description> = ''", | |
| 521 "repo_type" : "<type> = 'hg'", | |
|
2094
34d009e5147a
added clone_uri to API method for creating users
Marcin Kuzminski <marcin@python-works.com>
parents:
2091
diff
changeset
|
522 "private" : "<bool> = False", |
|
34d009e5147a
added clone_uri to API method for creating users
Marcin Kuzminski <marcin@python-works.com>
parents:
2091
diff
changeset
|
523 "clone_uri" : "<clone_uri> = None", |
| 1676 | 524 } |
| 525 | |
| 526 OUTPUT:: | |
| 527 | |
| 1928 | 528 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
529 "id": "<newrepoid>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
530 "msg": "Created new repository <reponame>", |
| 1928 | 531 } |
| 1676 | 532 error: null |
| 533 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
534 |
|
2091
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
535 delete_repo |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
536 ----------- |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
537 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
538 Deletes a repository. This command can be executed only using api_key |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
539 belonging to user with admin rights. |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
540 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
541 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
542 INPUT:: |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
543 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
544 id : <id_for_response> |
|
2091
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
545 api_key : "<api_key>" |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
546 method : "delete_repo" |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
547 args: { |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
548 "repo_name" : "<reponame>", |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
549 } |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
550 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
551 OUTPUT:: |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
552 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
553 result: { |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
554 "msg": "Deleted repository <reponame>", |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
555 } |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
556 error: null |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
557 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
558 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
559 grant_user_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
560 --------------------- |
| 1676 | 561 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
562 Grant permission for user on given repository, or update existing one |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
563 if found. This command can be executed only using api_key belonging to user |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
564 with admin rights. |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
565 |
| 1676 | 566 |
| 567 INPUT:: | |
| 568 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
569 id : <id_for_response> |
| 1676 | 570 api_key : "<api_key>" |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
571 method : "grant_user_permission" |
| 1676 | 572 args: { |
| 573 "repo_name" : "<reponame>", | |
| 1928 | 574 "username" : "<username>", |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
575 "perm" : "(repository.(none|read|write|admin))", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
576 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
577 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
578 OUTPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
579 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
580 result: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
581 "msg" : "Granted perm: <perm> for user: <username> in repo: <reponame>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
582 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
583 error: null |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
584 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
585 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
586 revoke_user_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
587 ---------------------- |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
588 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
589 Revoke permission for user on given repository. This command can be executed |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
590 only using api_key belonging to user with admin rights. |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
591 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
592 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
593 INPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
594 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
595 id : <id_for_response> |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
596 api_key : "<api_key>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
597 method : "revoke_user_permission" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
598 args: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
599 "repo_name" : "<reponame>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
600 "username" : "<username>", |
| 1676 | 601 } |
| 602 | |
| 603 OUTPUT:: | |
| 604 | |
| 1928 | 605 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
606 "msg" : "Revoked perm for user: <suername> in repo: <reponame>" |
| 1928 | 607 } |
| 1676 | 608 error: null |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
609 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
610 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
611 grant_users_group_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
612 ---------------------------- |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
613 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
614 Grant permission for users group on given repository, or update |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
615 existing one if found. This command can be executed only using |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
616 api_key belonging to user with admin rights. |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
617 |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
618 |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
619 INPUT:: |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
620 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
621 id : <id_for_response> |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
622 api_key : "<api_key>" |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
623 method : "grant_users_group_permission" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
624 args: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
625 "repo_name" : "<reponame>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
626 "group_name" : "<usersgroupname>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
627 "perm" : "(repository.(none|read|write|admin))", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
628 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
629 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
630 OUTPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
631 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
632 result: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
633 "msg" : "Granted perm: <perm> for group: <usersgroupname> in repo: <reponame>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
634 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
635 error: null |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
636 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
637 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
638 revoke_users_group_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
639 ----------------------------- |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
640 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
641 Revoke permission for users group on given repository.This command can be |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
642 executed only using api_key belonging to user with admin rights. |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
643 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
644 INPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
645 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
646 id : <id_for_response> |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
647 api_key : "<api_key>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
648 method : "revoke_users_group_permission" |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
649 args: { |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
650 "repo_name" : "<reponame>", |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
651 "users_group" : "<usersgroupname>", |
| 1928 | 652 } |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
653 |
| 1928 | 654 OUTPUT:: |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
655 |
| 1928 | 656 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
657 "msg" : "Revoked perm for group: <usersgroupname> in repo: <reponame>" |
| 1928 | 658 } |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
659 error: null |