Mercurial > public > src > rhodecode
annotate docs/api/api.rst @ 2609:374693af2849 beta
API: update_user returns new updated user data
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Mon, 25 Jun 2012 23:20:27 +0200 |
| parents | 7e3e9d0c5575 |
| children | d80a68e2ebcc |
| 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 | |
|
2481
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
62 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
63 API CLIENT |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
64 ++++++++++ |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
65 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
66 From version 1.4 RhodeCode adds a binary script that allows to easily |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
67 communicate with API. After installing RhodeCode a `rhodecode-api` script |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
68 will be available. |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
69 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
70 To get started quickly simply run:: |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
71 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
72 rhodecode-api _create_config --apikey=<youapikey> --apihost=<rhodecode host> |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
73 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
74 This will create a file named .config in the directory you executed it storing |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
75 json config file with credentials. You can skip this step and always provide |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
76 both of the arguments to be able to communicate with server |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
77 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
78 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
79 after that simply run any api command for example get_repo:: |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
80 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
81 rhodecode-api get_repo |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
82 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
83 calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
84 rhodecode said: |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
85 {'error': 'Missing non optional `repoid` arg in JSON DATA', |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
86 'id': 75, |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
87 'result': None} |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
88 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
89 Ups looks like we forgot to add an argument |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
90 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
91 Let's try again now giving the repoid as parameters:: |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
92 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
93 rhodecode-api get_repo repoid:rhodecode |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
94 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
95 calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "rhodecode"}, "method": "get_repo"} to http://127.0.0.1:5000 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
96 rhodecode said: |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
97 {'error': None, |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
98 'id': 39, |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
99 'result': <json data...>} |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
100 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
101 |
|
7ac09514a178
created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents:
2480
diff
changeset
|
102 |
| 1526 | 103 API METHODS |
| 104 +++++++++++ | |
| 105 | |
| 1676 | 106 |
| 1526 | 107 pull |
| 108 ---- | |
| 109 | |
| 1676 | 110 Pulls given repo from remote location. Can be used to automatically keep |
| 111 remote repos up to date. This command can be executed only using api_key | |
| 1580 | 112 belonging to user with admin rights |
| 113 | |
| 114 INPUT:: | |
| 115 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
116 id : <id_for_response> |
| 1676 | 117 api_key : "<api_key>" |
| 118 method : "pull" | |
| 119 args : { | |
| 1928 | 120 "repo_name" : "<reponame>" |
| 1676 | 121 } |
| 122 | |
| 123 OUTPUT:: | |
| 124 | |
| 1928 | 125 result : "Pulled from <reponame>" |
| 1676 | 126 error : null |
| 127 | |
| 128 | |
| 1928 | 129 get_user |
| 130 -------- | |
| 131 | |
|
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
|
132 Get's an user by username or user_id, Returns empty result if user is not found. |
| 1928 | 133 This command can be executed only using api_key belonging to user with admin |
| 134 rights. | |
| 135 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
136 |
| 1928 | 137 INPUT:: |
| 138 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
139 id : <id_for_response> |
| 1928 | 140 api_key : "<api_key>" |
| 141 method : "get_user" | |
| 142 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
|
143 "userid" : "<username or user_id>" |
| 1928 | 144 } |
| 145 | |
| 146 OUTPUT:: | |
| 147 | |
| 148 result: None if user does not exist or | |
| 149 { | |
| 150 "id" : "<id>", | |
| 151 "username" : "<username>", | |
| 152 "firstname": "<firstname>", | |
| 153 "lastname" : "<lastname>", | |
| 154 "email" : "<email>", | |
|
2608
7e3e9d0c5575
Add list of all emails that user may have into get_user call
Marcin Kuzminski <marcin@python-works.com>
parents:
2481
diff
changeset
|
155 "emails": "<list_of_all_additional_emails>", |
| 1928 | 156 "active" : "<bool>", |
| 157 "admin" :Â "<bool>", | |
|
2249
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
158 "ldap_dn" : "<ldap_dn>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
159 "last_login": "<last_login>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
160 "permissions": { |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
161 "global": ["hg.create.repository", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
162 "repository.read", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
163 "hg.register.manual_activate"], |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
164 "repositories": {"repo1": "repository.none"}, |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
165 "repositories_groups": {"Group1": "group.read"} |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
166 }, |
| 1928 | 167 } |
| 168 | |
| 169 error: null | |
| 170 | |
| 171 | |
| 1676 | 172 get_users |
| 173 --------- | |
| 174 | |
| 175 Lists all existing users. This command can be executed only using api_key | |
| 176 belonging to user with admin rights. | |
| 177 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
178 |
| 1676 | 179 INPUT:: |
| 180 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
181 id : <id_for_response> |
| 1676 | 182 api_key : "<api_key>" |
| 183 method : "get_users" | |
| 184 args : { } | |
| 185 | |
| 186 OUTPUT:: | |
| 187 | |
| 188 result: [ | |
| 189 { | |
| 190 "id" : "<id>", | |
| 191 "username" : "<username>", | |
| 192 "firstname": "<firstname>", | |
| 193 "lastname" : "<lastname>", | |
| 194 "email" : "<email>", | |
| 195 "active" : "<bool>", | |
| 196 "admin" :Â "<bool>", | |
|
2249
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
197 "ldap_dn" : "<ldap_dn>", |
|
12ceeda33339
#404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents:
2244
diff
changeset
|
198 "last_login": "<last_login>", |
| 1676 | 199 }, |
| 200 … | |
| 201 ] | |
| 202 error: null | |
| 203 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
204 |
| 1676 | 205 create_user |
| 206 ----------- | |
| 207 | |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
208 Creates new user. This command can |
|
1994
f2bd5b0c1094
create user api_doc update
Marcin Kuzminski <marcin@python-works.com>
parents:
1928
diff
changeset
|
209 be executed only using api_key belonging to user with admin rights. |
| 1676 | 210 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
211 |
| 1676 | 212 INPUT:: |
| 213 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
214 id : <id_for_response> |
| 1676 | 215 api_key : "<api_key>" |
| 216 method : "create_user" | |
| 217 args : { | |
| 218 "username" : "<username>", | |
| 219 "password" : "<password>", | |
|
2036
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
220 "email" : "<useremail>", |
|
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
221 "firstname" : "<firstname> = None", |
|
4ae17f819ee8
#344 optional firstname lastname on user creation
Marcin Kuzminski <marcin@python-works.com>
parents:
1996
diff
changeset
|
222 "lastname" : "<lastname> = None", |
| 1676 | 223 "active" : "<bool> = True", |
| 224 "admin" : "<bool> = False", | |
| 225 "ldap_dn" : "<ldap_dn> = None" | |
| 226 } | |
| 1580 | 227 |
| 228 OUTPUT:: | |
| 229 | |
| 1676 | 230 result: { |
| 1928 | 231 "id" : "<new_user_id>", |
|
2467
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
232 "msg" : "created new user <username>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
233 "user": { |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
234 "id" : "<id>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
235 "username" : "<username>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
236 "firstname": "<firstname>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
237 "lastname" : "<lastname>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
238 "email" : "<email>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
239 "active" : "<bool>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
240 "admin" :Â "<bool>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
241 "ldap_dn" : "<ldap_dn>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
242 "last_login": "<last_login>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
243 }, |
| 1676 | 244 } |
| 245 error: null | |
| 246 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
247 |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
248 update_user |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
249 ----------- |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
250 |
|
2467
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
251 updates given user if such user exists. This command can |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
252 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
|
253 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
254 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
255 INPUT:: |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
256 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
257 id : <id_for_response> |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
258 api_key : "<api_key>" |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
259 method : "update_user" |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
260 args : { |
| 2097 | 261 "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
|
262 "username" : "<username>", |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
263 "password" : "<password>", |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
264 "email" : "<useremail>", |
| 2097 | 265 "firstname" : "<firstname>", |
| 266 "lastname" : "<lastname>", | |
| 267 "active" : "<bool>", | |
| 268 "admin" : "<bool>", | |
| 269 "ldap_dn" : "<ldap_dn>" | |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
270 } |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
271 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
272 OUTPUT:: |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
273 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
274 result: { |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
275 "id" : "<edited_user_id>", |
|
2609
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
276 "msg" : "updated user ID:<userid> <username>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
277 "user": { |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
278 "id" : "<id>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
279 "username" : "<username>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
280 "firstname": "<firstname>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
281 "lastname" : "<lastname>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
282 "email" : "<email>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
283 "active" : "<bool>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
284 "admin" :Â "<bool>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
285 "ldap_dn" : "<ldap_dn>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
286 "last_login": "<last_login>", |
|
374693af2849
API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents:
2608
diff
changeset
|
287 }, |
|
2467
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
288 } |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
289 error: null |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
290 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
291 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
292 delete_user |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
293 ----------- |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
294 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
295 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
296 deletes givenuser if such user exists. This command can |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
297 be executed only using api_key belonging to user with admin rights. |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
298 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
299 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
300 INPUT:: |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
301 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
302 id : <id_for_response> |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
303 api_key : "<api_key>" |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
304 method : "delete_user" |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
305 args : { |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
306 "userid" : "<user_id or username>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
307 } |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
308 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
309 OUTPUT:: |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
310 |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
311 result: { |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
312 "id" : "<edited_user_id>", |
|
b902baeaa494
API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents:
2440
diff
changeset
|
313 "msg" : "deleted user ID:<userid> <username>" |
|
2090
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
314 } |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
315 error: null |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
316 |
|
bdc0ad168006
API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents:
2077
diff
changeset
|
317 |
| 1676 | 318 get_users_group |
| 319 --------------- | |
| 320 | |
| 321 Gets an existing users group. This command can be executed only using api_key | |
| 322 belonging to user with admin rights. | |
| 323 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
324 |
| 1676 | 325 INPUT:: |
| 326 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
327 id : <id_for_response> |
| 1676 | 328 api_key : "<api_key>" |
| 329 method : "get_users_group" | |
| 330 args : { | |
| 331 "group_name" : "<name>" | |
| 332 } | |
| 333 | |
| 334 OUTPUT:: | |
| 335 | |
| 336 result : None if group not exist | |
| 337 { | |
| 1928 | 338 "id" : "<id>", |
| 339 "group_name" : "<groupname>", | |
| 340 "active": "<bool>", | |
| 1676 | 341 "members" : [ |
| 1928 | 342 { "id" : "<userid>", |
| 343 "username" : "<username>", | |
| 344 "firstname": "<firstname>", | |
| 345 "lastname" : "<lastname>", | |
| 346 "email" : "<email>", | |
| 347 "active" : "<bool>", | |
| 348 "admin" :Â "<bool>", | |
| 349 "ldap" : "<ldap_dn>" | |
| 350 }, | |
| 351 … | |
| 352 ] | |
| 1676 | 353 } |
| 354 error : null | |
| 355 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
356 |
| 1928 | 357 get_users_groups |
| 358 ---------------- | |
| 359 | |
| 360 Lists all existing users groups. This command can be executed only using | |
| 361 api_key belonging to user with admin rights. | |
| 362 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
363 |
| 1928 | 364 INPUT:: |
| 365 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
366 id : <id_for_response> |
| 1928 | 367 api_key : "<api_key>" |
| 368 method : "get_users_groups" | |
| 369 args : { } | |
| 370 | |
| 371 OUTPUT:: | |
| 372 | |
| 373 result : [ | |
| 374 { | |
| 375 "id" : "<id>", | |
| 376 "group_name" : "<groupname>", | |
| 377 "active": "<bool>", | |
| 378 "members" : [ | |
| 379 { | |
| 380 "id" : "<userid>", | |
| 381 "username" : "<username>", | |
| 382 "firstname": "<firstname>", | |
| 383 "lastname" : "<lastname>", | |
| 384 "email" : "<email>", | |
| 385 "active" : "<bool>", | |
| 386 "admin" :Â "<bool>", | |
| 387 "ldap" : "<ldap_dn>" | |
| 388 }, | |
| 389 … | |
| 390 ] | |
| 391 } | |
| 392 ] | |
| 393 error : null | |
| 394 | |
| 395 | |
| 1580 | 396 create_users_group |
| 397 ------------------ | |
| 398 | |
| 1676 | 399 Creates new users group. This command can be executed only using api_key |
| 1580 | 400 belonging to user with admin rights |
| 401 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
402 |
| 1580 | 403 INPUT:: |
| 404 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
405 id : <id_for_response> |
| 1676 | 406 api_key : "<api_key>" |
| 407 method : "create_users_group" | |
| 408 args: { | |
| 1928 | 409 "group_name": "<groupname>", |
| 1676 | 410 "active":"<bool> = True" |
| 411 } | |
| 412 | |
| 413 OUTPUT:: | |
| 414 | |
| 415 result: { | |
| 416 "id": "<newusersgroupid>", | |
| 1928 | 417 "msg": "created new users group <groupname>" |
| 1676 | 418 } |
| 419 error: null | |
| 420 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
421 |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
422 add_user_to_users_group |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
423 ----------------------- |
| 1676 | 424 |
| 2077 | 425 Adds a user to a users group. If user exists in that group success will be |
| 426 `false`. This command can be executed only using api_key | |
| 1676 | 427 belonging to user with admin rights |
| 428 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
429 |
| 1676 | 430 INPUT:: |
| 431 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
432 id : <id_for_response> |
| 1676 | 433 api_key : "<api_key>" |
| 434 method : "add_user_users_group" | |
| 435 args: { | |
| 436 "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
|
437 "username" : "<username>" |
| 1676 | 438 } |
| 439 | |
| 440 OUTPUT:: | |
| 441 | |
| 442 result: { | |
| 443 "id": "<newusersgroupmemberid>", | |
| 2077 | 444 "success": True|False # depends on if member is in group |
| 445 "msg": "added member <username> to users group <groupname> | | |
| 446 User is already in that group" | |
| 447 } | |
| 448 error: null | |
| 449 | |
| 450 | |
| 451 remove_user_from_users_group | |
| 452 ---------------------------- | |
| 453 | |
| 454 Removes a user from a users group. If user is not in given group success will | |
| 455 be `false`. This command can be executed only | |
| 456 using api_key belonging to user with admin rights | |
| 457 | |
| 458 | |
| 459 INPUT:: | |
| 460 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
461 id : <id_for_response> |
| 2077 | 462 api_key : "<api_key>" |
| 463 method : "remove_user_from_users_group" | |
| 464 args: { | |
| 465 "group_name" : "<groupname>", | |
| 466 "username" : "<username>" | |
| 467 } | |
| 468 | |
| 469 OUTPUT:: | |
| 470 | |
| 471 result: { | |
| 472 "success": True|False, # depends on if member is in group | |
| 473 "msg": "removed member <username> from users group <groupname> | | |
| 474 User wasn't in group" | |
| 1676 | 475 } |
| 476 error: null | |
| 477 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
478 |
| 1928 | 479 get_repo |
| 480 -------- | |
| 481 | |
| 2244 | 482 Gets an existing repository by it's name or repository_id. Members will return |
| 483 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
|
484 be executed only using api_key belonging to user with admin rights. |
| 1928 | 485 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
486 |
| 1928 | 487 INPUT:: |
| 488 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
489 id : <id_for_response> |
| 1928 | 490 api_key : "<api_key>" |
| 491 method : "get_repo" | |
| 492 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
|
493 "repoid" : "<reponame or repo_id>" |
| 1928 | 494 } |
| 495 | |
| 496 OUTPUT:: | |
| 497 | |
| 498 result: None if repository does not exist or | |
| 499 { | |
| 500 "id" : "<id>", | |
| 501 "repo_name" : "<reponame>" | |
| 502 "type" : "<type>", | |
| 503 "description" : "<description>", | |
|
2440
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
504 "clone_uri" : "<clone_uri>", |
|
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
505 "private": : "<bool>", |
|
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
506 "created_on" : "<datetimecreated>", |
| 1928 | 507 "members" : [ |
| 2244 | 508 { |
| 509 "type": "user", | |
| 510 "id" : "<userid>", | |
| 1928 | 511 "username" : "<username>", |
| 512 "firstname": "<firstname>", | |
| 513 "lastname" : "<lastname>", | |
| 514 "email" : "<email>", | |
| 515 "active" : "<bool>", | |
| 516 "admin" :Â "<bool>", | |
| 517 "ldap" : "<ldap_dn>", | |
| 518 "permission" : "repository.(read|write|admin)" | |
| 519 }, | |
| 520 … | |
| 2244 | 521 { |
| 522 "type": "users_group", | |
| 1928 | 523 "id" : "<usersgroupid>", |
| 524 "name" : "<usersgroupname>", | |
| 525 "active": "<bool>", | |
| 526 "permission" : "repository.(read|write|admin)" | |
| 527 }, | |
| 528 … | |
| 529 ] | |
| 530 } | |
| 531 error: null | |
| 532 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
533 |
| 1676 | 534 get_repos |
| 535 --------- | |
| 536 | |
| 537 Lists all existing repositories. This command can be executed only using api_key | |
| 538 belonging to user with admin rights | |
| 539 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
540 |
| 1676 | 541 INPUT:: |
| 542 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
543 id : <id_for_response> |
| 1676 | 544 api_key : "<api_key>" |
| 545 method : "get_repos" | |
| 546 args: { } | |
| 1580 | 547 |
| 548 OUTPUT:: | |
| 549 | |
| 1676 | 550 result: [ |
| 551 { | |
| 552 "id" : "<id>", | |
| 1928 | 553 "repo_name" : "<reponame>" |
| 1676 | 554 "type" : "<type>", |
|
2440
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
555 "description" : "<description>", |
|
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
556 "clone_uri" : "<clone_uri>", |
|
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
557 "private": : "<bool>", |
|
347b00545b60
Updated API to return clone_uri, private, created_on
Marcin Kuzminski <marcin@python-works.com>
parents:
2249
diff
changeset
|
558 "created_on" : "<datetimecreated>", |
| 1676 | 559 }, |
| 560 … | |
| 561 ] | |
| 562 error: null | |
| 563 | |
| 564 | |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
565 get_repo_nodes |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
566 -------------- |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
567 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
568 returns a list of nodes and it's children in a flat list for a given path |
| 1928 | 569 at given revision. It's possible to specify ret_type to show only `files` or |
| 570 `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
|
571 with admin rights |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
572 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
573 |
|
1895
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
574 INPUT:: |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
575 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
576 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
|
577 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
|
578 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
|
579 args: { |
| 1928 | 580 "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
|
581 "revision" : "<revision>", |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
582 "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
|
583 "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
|
584 } |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
585 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
586 OUTPUT:: |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
587 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
588 result: [ |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
589 { |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
590 "name" : "<name>" |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
591 "type" : "<type>", |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
592 }, |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
593 … |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
594 ] |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
595 error: null |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
596 |
|
203af05539e0
implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents:
1878
diff
changeset
|
597 |
| 1676 | 598 create_repo |
| 599 ----------- | |
| 600 | |
| 601 Creates a repository. This command can be executed only using api_key | |
| 602 belonging to user with admin rights. | |
| 603 If repository name contains "/", all needed repository groups will be created. | |
| 604 For example "foo/bar/baz" will create groups "foo", "bar" (with "foo" as parent), | |
| 605 and create "baz" repository with "bar" as group. | |
| 606 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
607 |
| 1676 | 608 INPUT:: |
| 609 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
610 id : <id_for_response> |
| 1676 | 611 api_key : "<api_key>" |
| 612 method : "create_repo" | |
| 613 args: { | |
| 1928 | 614 "repo_name" : "<reponame>", |
| 1676 | 615 "owner_name" : "<ownername>", |
| 616 "description" : "<description> = ''", | |
| 617 "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
|
618 "private" : "<bool> = False", |
|
34d009e5147a
added clone_uri to API method for creating users
Marcin Kuzminski <marcin@python-works.com>
parents:
2091
diff
changeset
|
619 "clone_uri" : "<clone_uri> = None", |
| 1676 | 620 } |
| 621 | |
| 622 OUTPUT:: | |
| 623 | |
| 1928 | 624 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
625 "id": "<newrepoid>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
626 "msg": "Created new repository <reponame>", |
|
2480
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
627 "repo": { |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
628 "id" : "<id>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
629 "repo_name" : "<reponame>" |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
630 "type" : "<type>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
631 "description" : "<description>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
632 "clone_uri" : "<clone_uri>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
633 "private": : "<bool>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
634 "created_on" : "<datetimecreated>", |
|
04ef27ce939e
API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents:
2467
diff
changeset
|
635 }, |
| 1928 | 636 } |
| 1676 | 637 error: null |
| 638 | |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
639 |
|
2091
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
640 delete_repo |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
641 ----------- |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
642 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
643 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
|
644 belonging to user with admin rights. |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
645 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
646 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
647 INPUT:: |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
648 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
649 id : <id_for_response> |
|
2091
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
650 api_key : "<api_key>" |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
651 method : "delete_repo" |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
652 args: { |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
653 "repo_name" : "<reponame>", |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
654 } |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
655 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
656 OUTPUT:: |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
657 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
658 result: { |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
659 "msg": "Deleted repository <reponame>", |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
660 } |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
661 error: null |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
662 |
|
7dfcdf4c7dd2
implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents:
2090
diff
changeset
|
663 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
664 grant_user_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
665 --------------------- |
| 1676 | 666 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
667 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
|
668 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
|
669 with admin rights. |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
670 |
| 1676 | 671 |
| 672 INPUT:: | |
| 673 | |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
674 id : <id_for_response> |
| 1676 | 675 api_key : "<api_key>" |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
676 method : "grant_user_permission" |
| 1676 | 677 args: { |
| 678 "repo_name" : "<reponame>", | |
| 1928 | 679 "username" : "<username>", |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
680 "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
|
681 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
682 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
683 OUTPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
684 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
685 result: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
686 "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
|
687 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
688 error: null |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
689 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
690 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
691 revoke_user_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
692 ---------------------- |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
693 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
694 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
|
695 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
|
696 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
697 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
698 INPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
699 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
700 id : <id_for_response> |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
701 api_key : "<api_key>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
702 method : "revoke_user_permission" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
703 args: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
704 "repo_name" : "<reponame>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
705 "username" : "<username>", |
| 1676 | 706 } |
| 707 | |
| 708 OUTPUT:: | |
| 709 | |
| 1928 | 710 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
711 "msg" : "Revoked perm for user: <suername> in repo: <reponame>" |
| 1928 | 712 } |
| 1676 | 713 error: null |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
714 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
715 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
716 grant_users_group_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
717 ---------------------------- |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
718 |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
719 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
|
720 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
|
721 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
|
722 |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
723 |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
724 INPUT:: |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
725 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
726 id : <id_for_response> |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
727 api_key : "<api_key>" |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
728 method : "grant_users_group_permission" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
729 args: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
730 "repo_name" : "<reponame>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
731 "group_name" : "<usersgroupname>", |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
732 "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
|
733 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
734 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
735 OUTPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
736 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
737 result: { |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
738 "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
|
739 } |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
740 error: null |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
741 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
742 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
743 revoke_users_group_permission |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
744 ----------------------------- |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
745 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
746 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
|
747 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
|
748 |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
749 INPUT:: |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
750 |
|
2241
c1f1f0661090
API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents:
2191
diff
changeset
|
751 id : <id_for_response> |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
752 api_key : "<api_key>" |
|
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
753 method : "revoke_users_group_permission" |
|
1878
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
754 args: { |
|
631caf880b87
implements #329
Marcin Kuzminski <marcin@python-works.com>
parents:
1793
diff
changeset
|
755 "repo_name" : "<reponame>", |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
756 "users_group" : "<usersgroupname>", |
| 1928 | 757 } |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
758 |
| 1928 | 759 OUTPUT:: |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
760 |
| 1928 | 761 result: { |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
762 "msg" : "Revoked perm for group: <usersgroupname> in repo: <reponame>" |
| 1928 | 763 } |
|
2070
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
2036
diff
changeset
|
764 error: null |