1
0

openapi.json 181 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "provisioning_api",
  5. "version": "0.0.1",
  6. "description": "This application enables a set of APIs that external systems can use to manage users, groups and apps.",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "AppInfo": {
  24. "type": "object",
  25. "required": [
  26. "active",
  27. "activity",
  28. "author",
  29. "background-jobs",
  30. "bugs",
  31. "category",
  32. "collaboration",
  33. "commands",
  34. "default_enable",
  35. "dependencies",
  36. "description",
  37. "discussion",
  38. "documentation",
  39. "groups",
  40. "id",
  41. "info",
  42. "internal",
  43. "level",
  44. "licence",
  45. "name",
  46. "namespace",
  47. "navigations",
  48. "preview",
  49. "previewAsIcon",
  50. "public",
  51. "remote",
  52. "removable",
  53. "repair-steps",
  54. "repository",
  55. "sabre",
  56. "screenshot",
  57. "settings",
  58. "summary",
  59. "trash",
  60. "two-factor-providers",
  61. "types",
  62. "version",
  63. "versions",
  64. "website"
  65. ],
  66. "properties": {
  67. "active": {
  68. "type": "boolean",
  69. "nullable": true
  70. },
  71. "activity": {
  72. "type": "object",
  73. "nullable": true
  74. },
  75. "author": {
  76. "type": "object",
  77. "nullable": true
  78. },
  79. "background-jobs": {
  80. "type": "object",
  81. "nullable": true
  82. },
  83. "bugs": {
  84. "type": "object",
  85. "nullable": true
  86. },
  87. "category": {
  88. "type": "object",
  89. "nullable": true
  90. },
  91. "collaboration": {
  92. "type": "object",
  93. "nullable": true
  94. },
  95. "commands": {
  96. "type": "object",
  97. "nullable": true
  98. },
  99. "default_enable": {
  100. "type": "object",
  101. "nullable": true
  102. },
  103. "dependencies": {
  104. "type": "object",
  105. "nullable": true
  106. },
  107. "description": {
  108. "type": "string"
  109. },
  110. "discussion": {
  111. "type": "object",
  112. "nullable": true
  113. },
  114. "documentation": {
  115. "type": "object",
  116. "nullable": true
  117. },
  118. "groups": {
  119. "type": "object",
  120. "nullable": true
  121. },
  122. "id": {
  123. "type": "string"
  124. },
  125. "info": {
  126. "type": "object",
  127. "nullable": true
  128. },
  129. "internal": {
  130. "type": "boolean",
  131. "nullable": true
  132. },
  133. "level": {
  134. "type": "integer",
  135. "format": "int64",
  136. "nullable": true
  137. },
  138. "licence": {
  139. "type": "object",
  140. "nullable": true
  141. },
  142. "name": {
  143. "type": "string"
  144. },
  145. "namespace": {
  146. "type": "object",
  147. "nullable": true
  148. },
  149. "navigations": {
  150. "type": "object",
  151. "nullable": true
  152. },
  153. "preview": {
  154. "type": "object",
  155. "nullable": true
  156. },
  157. "previewAsIcon": {
  158. "type": "boolean",
  159. "nullable": true
  160. },
  161. "public": {
  162. "type": "object",
  163. "nullable": true
  164. },
  165. "remote": {
  166. "type": "object",
  167. "nullable": true
  168. },
  169. "removable": {
  170. "type": "boolean",
  171. "nullable": true
  172. },
  173. "repair-steps": {
  174. "type": "object",
  175. "nullable": true
  176. },
  177. "repository": {
  178. "type": "object",
  179. "nullable": true
  180. },
  181. "sabre": {
  182. "type": "object",
  183. "nullable": true
  184. },
  185. "screenshot": {
  186. "type": "object",
  187. "nullable": true
  188. },
  189. "settings": {
  190. "type": "object",
  191. "nullable": true
  192. },
  193. "summary": {
  194. "type": "string"
  195. },
  196. "trash": {
  197. "type": "object",
  198. "nullable": true
  199. },
  200. "two-factor-providers": {
  201. "type": "object",
  202. "nullable": true
  203. },
  204. "types": {
  205. "type": "object",
  206. "nullable": true
  207. },
  208. "version": {
  209. "type": "string"
  210. },
  211. "versions": {
  212. "type": "object",
  213. "nullable": true
  214. },
  215. "website": {
  216. "type": "object",
  217. "nullable": true
  218. }
  219. }
  220. },
  221. "Capabilities": {
  222. "type": "object",
  223. "required": [
  224. "provisioning_api"
  225. ],
  226. "properties": {
  227. "provisioning_api": {
  228. "type": "object",
  229. "required": [
  230. "version",
  231. "AccountPropertyScopesVersion",
  232. "AccountPropertyScopesFederatedEnabled",
  233. "AccountPropertyScopesPublishedEnabled"
  234. ],
  235. "properties": {
  236. "version": {
  237. "type": "string"
  238. },
  239. "AccountPropertyScopesVersion": {
  240. "type": "integer",
  241. "format": "int64"
  242. },
  243. "AccountPropertyScopesFederatedEnabled": {
  244. "type": "boolean"
  245. },
  246. "AccountPropertyScopesPublishedEnabled": {
  247. "type": "boolean"
  248. }
  249. }
  250. }
  251. }
  252. },
  253. "GroupDetails": {
  254. "type": "object",
  255. "required": [
  256. "id",
  257. "displayname",
  258. "usercount",
  259. "disabled",
  260. "canAdd",
  261. "canRemove"
  262. ],
  263. "properties": {
  264. "id": {
  265. "type": "string"
  266. },
  267. "displayname": {
  268. "type": "string"
  269. },
  270. "usercount": {
  271. "oneOf": [
  272. {
  273. "type": "boolean"
  274. },
  275. {
  276. "type": "integer",
  277. "format": "int64"
  278. }
  279. ]
  280. },
  281. "disabled": {
  282. "oneOf": [
  283. {
  284. "type": "boolean"
  285. },
  286. {
  287. "type": "integer",
  288. "format": "int64"
  289. }
  290. ]
  291. },
  292. "canAdd": {
  293. "type": "boolean"
  294. },
  295. "canRemove": {
  296. "type": "boolean"
  297. }
  298. }
  299. },
  300. "OCSMeta": {
  301. "type": "object",
  302. "required": [
  303. "status",
  304. "statuscode"
  305. ],
  306. "properties": {
  307. "status": {
  308. "type": "string"
  309. },
  310. "statuscode": {
  311. "type": "integer"
  312. },
  313. "message": {
  314. "type": "string"
  315. },
  316. "totalitems": {
  317. "type": "string"
  318. },
  319. "itemsperpage": {
  320. "type": "string"
  321. }
  322. }
  323. },
  324. "UserDetails": {
  325. "type": "object",
  326. "required": [
  327. "additional_mail",
  328. "additional_mailScope",
  329. "address",
  330. "addressScope",
  331. "avatarScope",
  332. "backend",
  333. "backendCapabilities",
  334. "biography",
  335. "biographyScope",
  336. "displayname",
  337. "display-name",
  338. "displaynameScope",
  339. "email",
  340. "emailScope",
  341. "enabled",
  342. "fediverse",
  343. "fediverseScope",
  344. "groups",
  345. "headline",
  346. "headlineScope",
  347. "id",
  348. "language",
  349. "lastLogin",
  350. "locale",
  351. "notify_email",
  352. "organisation",
  353. "organisationScope",
  354. "phone",
  355. "phoneScope",
  356. "profile_enabled",
  357. "profile_enabledScope",
  358. "quota",
  359. "role",
  360. "roleScope",
  361. "storageLocation",
  362. "subadmin",
  363. "twitter",
  364. "twitterScope",
  365. "website",
  366. "websiteScope"
  367. ],
  368. "properties": {
  369. "additional_mail": {
  370. "type": "array",
  371. "items": {
  372. "type": "string"
  373. }
  374. },
  375. "additional_mailScope": {
  376. "type": "array",
  377. "nullable": true,
  378. "items": {
  379. "type": "string"
  380. }
  381. },
  382. "address": {
  383. "type": "string"
  384. },
  385. "addressScope": {
  386. "type": "string",
  387. "nullable": true
  388. },
  389. "avatarScope": {
  390. "type": "string",
  391. "nullable": true
  392. },
  393. "backend": {
  394. "type": "string"
  395. },
  396. "backendCapabilities": {
  397. "type": "object",
  398. "required": [
  399. "setDisplayName",
  400. "setPassword"
  401. ],
  402. "properties": {
  403. "setDisplayName": {
  404. "type": "boolean"
  405. },
  406. "setPassword": {
  407. "type": "boolean"
  408. }
  409. }
  410. },
  411. "biography": {
  412. "type": "string"
  413. },
  414. "biographyScope": {
  415. "type": "string",
  416. "nullable": true
  417. },
  418. "displayname": {
  419. "type": "string"
  420. },
  421. "display-name": {
  422. "type": "string"
  423. },
  424. "displaynameScope": {
  425. "type": "string",
  426. "nullable": true
  427. },
  428. "email": {
  429. "type": "string",
  430. "nullable": true
  431. },
  432. "emailScope": {
  433. "type": "string",
  434. "nullable": true
  435. },
  436. "enabled": {
  437. "type": "boolean",
  438. "nullable": true
  439. },
  440. "fediverse": {
  441. "type": "string",
  442. "nullable": true
  443. },
  444. "fediverseScope": {
  445. "type": "string",
  446. "nullable": true
  447. },
  448. "groups": {
  449. "type": "array",
  450. "items": {
  451. "type": "string"
  452. }
  453. },
  454. "headline": {
  455. "type": "string"
  456. },
  457. "headlineScope": {
  458. "type": "string",
  459. "nullable": true
  460. },
  461. "id": {
  462. "type": "string"
  463. },
  464. "language": {
  465. "type": "string"
  466. },
  467. "lastLogin": {
  468. "type": "integer",
  469. "format": "int64"
  470. },
  471. "locale": {
  472. "type": "string"
  473. },
  474. "notify_email": {
  475. "type": "string",
  476. "nullable": true
  477. },
  478. "organisation": {
  479. "type": "string"
  480. },
  481. "organisationScope": {
  482. "type": "string",
  483. "nullable": true
  484. },
  485. "phone": {
  486. "type": "string"
  487. },
  488. "phoneScope": {
  489. "type": "string",
  490. "nullable": true
  491. },
  492. "profile_enabled": {
  493. "type": "string"
  494. },
  495. "profile_enabledScope": {
  496. "type": "string",
  497. "nullable": true
  498. },
  499. "quota": {
  500. "type": "object",
  501. "required": [
  502. "free",
  503. "quota",
  504. "relative",
  505. "total",
  506. "used"
  507. ],
  508. "properties": {
  509. "free": {
  510. "type": "integer",
  511. "format": "int64",
  512. "nullable": true
  513. },
  514. "quota": {
  515. "oneOf": [
  516. {
  517. "type": "string"
  518. },
  519. {
  520. "type": "integer",
  521. "format": "int64"
  522. },
  523. {
  524. "type": "boolean"
  525. }
  526. ]
  527. },
  528. "relative": {
  529. "type": "number",
  530. "format": "float",
  531. "nullable": true
  532. },
  533. "total": {
  534. "type": "integer",
  535. "format": "int64",
  536. "nullable": true
  537. },
  538. "used": {
  539. "type": "integer",
  540. "format": "int64"
  541. }
  542. }
  543. },
  544. "role": {
  545. "type": "string"
  546. },
  547. "roleScope": {
  548. "type": "string",
  549. "nullable": true
  550. },
  551. "storageLocation": {
  552. "type": "string",
  553. "nullable": true
  554. },
  555. "subadmin": {
  556. "type": "array",
  557. "items": {
  558. "type": "string"
  559. }
  560. },
  561. "twitter": {
  562. "type": "string"
  563. },
  564. "twitterScope": {
  565. "type": "string",
  566. "nullable": true
  567. },
  568. "website": {
  569. "type": "string"
  570. },
  571. "websiteScope": {
  572. "type": "string",
  573. "nullable": true
  574. }
  575. }
  576. }
  577. }
  578. },
  579. "paths": {
  580. "/ocs/v2.php/cloud/apps": {
  581. "get": {
  582. "operationId": "apps-get-apps",
  583. "summary": "Get a list of installed apps",
  584. "description": "This endpoint requires admin access",
  585. "tags": [
  586. "apps"
  587. ],
  588. "security": [
  589. {
  590. "bearer_auth": []
  591. },
  592. {
  593. "basic_auth": []
  594. }
  595. ],
  596. "parameters": [
  597. {
  598. "name": "filter",
  599. "in": "query",
  600. "description": "Filter for enabled or disabled apps",
  601. "schema": {
  602. "type": "string",
  603. "nullable": true
  604. }
  605. },
  606. {
  607. "name": "OCS-APIRequest",
  608. "in": "header",
  609. "required": true,
  610. "schema": {
  611. "type": "string",
  612. "default": "true"
  613. }
  614. }
  615. ],
  616. "responses": {
  617. "200": {
  618. "description": "",
  619. "content": {
  620. "application/json": {
  621. "schema": {
  622. "type": "object",
  623. "required": [
  624. "ocs"
  625. ],
  626. "properties": {
  627. "ocs": {
  628. "type": "object",
  629. "required": [
  630. "meta",
  631. "data"
  632. ],
  633. "properties": {
  634. "meta": {
  635. "$ref": "#/components/schemas/OCSMeta"
  636. },
  637. "data": {
  638. "type": "object",
  639. "required": [
  640. "apps"
  641. ],
  642. "properties": {
  643. "apps": {
  644. "type": "array",
  645. "items": {
  646. "type": "string"
  647. }
  648. }
  649. }
  650. }
  651. }
  652. }
  653. }
  654. }
  655. }
  656. }
  657. }
  658. }
  659. }
  660. },
  661. "/ocs/v2.php/cloud/apps/{app}": {
  662. "get": {
  663. "operationId": "apps-get-app-info",
  664. "summary": "Get the app info for an app",
  665. "description": "This endpoint requires admin access",
  666. "tags": [
  667. "apps"
  668. ],
  669. "security": [
  670. {
  671. "bearer_auth": []
  672. },
  673. {
  674. "basic_auth": []
  675. }
  676. ],
  677. "parameters": [
  678. {
  679. "name": "app",
  680. "in": "path",
  681. "description": "ID of the app",
  682. "required": true,
  683. "schema": {
  684. "type": "string"
  685. }
  686. },
  687. {
  688. "name": "OCS-APIRequest",
  689. "in": "header",
  690. "required": true,
  691. "schema": {
  692. "type": "string",
  693. "default": "true"
  694. }
  695. }
  696. ],
  697. "responses": {
  698. "200": {
  699. "description": "",
  700. "content": {
  701. "application/json": {
  702. "schema": {
  703. "type": "object",
  704. "required": [
  705. "ocs"
  706. ],
  707. "properties": {
  708. "ocs": {
  709. "type": "object",
  710. "required": [
  711. "meta",
  712. "data"
  713. ],
  714. "properties": {
  715. "meta": {
  716. "$ref": "#/components/schemas/OCSMeta"
  717. },
  718. "data": {
  719. "$ref": "#/components/schemas/AppInfo"
  720. }
  721. }
  722. }
  723. }
  724. }
  725. }
  726. }
  727. }
  728. }
  729. },
  730. "post": {
  731. "operationId": "apps-enable",
  732. "summary": "Enable an app",
  733. "description": "This endpoint requires admin access",
  734. "tags": [
  735. "apps"
  736. ],
  737. "security": [
  738. {
  739. "bearer_auth": []
  740. },
  741. {
  742. "basic_auth": []
  743. }
  744. ],
  745. "parameters": [
  746. {
  747. "name": "app",
  748. "in": "path",
  749. "description": "ID of the app",
  750. "required": true,
  751. "schema": {
  752. "type": "string"
  753. }
  754. },
  755. {
  756. "name": "OCS-APIRequest",
  757. "in": "header",
  758. "required": true,
  759. "schema": {
  760. "type": "string",
  761. "default": "true"
  762. }
  763. }
  764. ],
  765. "responses": {
  766. "200": {
  767. "description": "",
  768. "content": {
  769. "application/json": {
  770. "schema": {
  771. "type": "object",
  772. "required": [
  773. "ocs"
  774. ],
  775. "properties": {
  776. "ocs": {
  777. "type": "object",
  778. "required": [
  779. "meta",
  780. "data"
  781. ],
  782. "properties": {
  783. "meta": {
  784. "$ref": "#/components/schemas/OCSMeta"
  785. },
  786. "data": {
  787. "type": "object",
  788. "additionalProperties": true
  789. }
  790. }
  791. }
  792. }
  793. }
  794. }
  795. }
  796. }
  797. }
  798. },
  799. "delete": {
  800. "operationId": "apps-disable",
  801. "summary": "Disable an app",
  802. "description": "This endpoint requires admin access",
  803. "tags": [
  804. "apps"
  805. ],
  806. "security": [
  807. {
  808. "bearer_auth": []
  809. },
  810. {
  811. "basic_auth": []
  812. }
  813. ],
  814. "parameters": [
  815. {
  816. "name": "app",
  817. "in": "path",
  818. "description": "ID of the app",
  819. "required": true,
  820. "schema": {
  821. "type": "string"
  822. }
  823. },
  824. {
  825. "name": "OCS-APIRequest",
  826. "in": "header",
  827. "required": true,
  828. "schema": {
  829. "type": "string",
  830. "default": "true"
  831. }
  832. }
  833. ],
  834. "responses": {
  835. "200": {
  836. "description": "",
  837. "content": {
  838. "application/json": {
  839. "schema": {
  840. "type": "object",
  841. "required": [
  842. "ocs"
  843. ],
  844. "properties": {
  845. "ocs": {
  846. "type": "object",
  847. "required": [
  848. "meta",
  849. "data"
  850. ],
  851. "properties": {
  852. "meta": {
  853. "$ref": "#/components/schemas/OCSMeta"
  854. },
  855. "data": {
  856. "type": "object",
  857. "additionalProperties": true
  858. }
  859. }
  860. }
  861. }
  862. }
  863. }
  864. }
  865. }
  866. }
  867. }
  868. },
  869. "/ocs/v2.php/cloud/groups": {
  870. "get": {
  871. "operationId": "groups-get-groups",
  872. "summary": "Get a list of groups",
  873. "tags": [
  874. "groups"
  875. ],
  876. "security": [
  877. {
  878. "bearer_auth": []
  879. },
  880. {
  881. "basic_auth": []
  882. }
  883. ],
  884. "parameters": [
  885. {
  886. "name": "search",
  887. "in": "query",
  888. "description": "Text to search for",
  889. "schema": {
  890. "type": "string",
  891. "default": ""
  892. }
  893. },
  894. {
  895. "name": "limit",
  896. "in": "query",
  897. "description": "Limit the amount of groups returned",
  898. "schema": {
  899. "type": "integer",
  900. "format": "int64",
  901. "nullable": true
  902. }
  903. },
  904. {
  905. "name": "offset",
  906. "in": "query",
  907. "description": "Offset for searching for groups",
  908. "schema": {
  909. "type": "integer",
  910. "format": "int64",
  911. "default": 0
  912. }
  913. },
  914. {
  915. "name": "OCS-APIRequest",
  916. "in": "header",
  917. "required": true,
  918. "schema": {
  919. "type": "string",
  920. "default": "true"
  921. }
  922. }
  923. ],
  924. "responses": {
  925. "200": {
  926. "description": "",
  927. "content": {
  928. "application/json": {
  929. "schema": {
  930. "type": "object",
  931. "required": [
  932. "ocs"
  933. ],
  934. "properties": {
  935. "ocs": {
  936. "type": "object",
  937. "required": [
  938. "meta",
  939. "data"
  940. ],
  941. "properties": {
  942. "meta": {
  943. "$ref": "#/components/schemas/OCSMeta"
  944. },
  945. "data": {
  946. "type": "object",
  947. "required": [
  948. "groups"
  949. ],
  950. "properties": {
  951. "groups": {
  952. "type": "array",
  953. "items": {
  954. "type": "string"
  955. }
  956. }
  957. }
  958. }
  959. }
  960. }
  961. }
  962. }
  963. }
  964. }
  965. }
  966. }
  967. },
  968. "post": {
  969. "operationId": "groups-add-group",
  970. "summary": "Create a new group",
  971. "description": "This endpoint requires admin access",
  972. "tags": [
  973. "groups"
  974. ],
  975. "security": [
  976. {
  977. "bearer_auth": []
  978. },
  979. {
  980. "basic_auth": []
  981. }
  982. ],
  983. "parameters": [
  984. {
  985. "name": "groupid",
  986. "in": "query",
  987. "description": "ID of the group",
  988. "required": true,
  989. "schema": {
  990. "type": "string"
  991. }
  992. },
  993. {
  994. "name": "displayname",
  995. "in": "query",
  996. "description": "Display name of the group",
  997. "schema": {
  998. "type": "string",
  999. "default": ""
  1000. }
  1001. },
  1002. {
  1003. "name": "OCS-APIRequest",
  1004. "in": "header",
  1005. "required": true,
  1006. "schema": {
  1007. "type": "string",
  1008. "default": "true"
  1009. }
  1010. }
  1011. ],
  1012. "responses": {
  1013. "200": {
  1014. "description": "",
  1015. "content": {
  1016. "application/json": {
  1017. "schema": {
  1018. "type": "object",
  1019. "required": [
  1020. "ocs"
  1021. ],
  1022. "properties": {
  1023. "ocs": {
  1024. "type": "object",
  1025. "required": [
  1026. "meta",
  1027. "data"
  1028. ],
  1029. "properties": {
  1030. "meta": {
  1031. "$ref": "#/components/schemas/OCSMeta"
  1032. },
  1033. "data": {
  1034. "type": "object",
  1035. "additionalProperties": true
  1036. }
  1037. }
  1038. }
  1039. }
  1040. }
  1041. }
  1042. }
  1043. }
  1044. }
  1045. }
  1046. },
  1047. "/ocs/v2.php/cloud/groups/details": {
  1048. "get": {
  1049. "operationId": "groups-get-groups-details",
  1050. "summary": "Get a list of groups details",
  1051. "tags": [
  1052. "groups"
  1053. ],
  1054. "security": [
  1055. {
  1056. "bearer_auth": []
  1057. },
  1058. {
  1059. "basic_auth": []
  1060. }
  1061. ],
  1062. "parameters": [
  1063. {
  1064. "name": "search",
  1065. "in": "query",
  1066. "description": "Text to search for",
  1067. "schema": {
  1068. "type": "string",
  1069. "default": ""
  1070. }
  1071. },
  1072. {
  1073. "name": "limit",
  1074. "in": "query",
  1075. "description": "Limit the amount of groups returned",
  1076. "schema": {
  1077. "type": "integer",
  1078. "format": "int64",
  1079. "nullable": true
  1080. }
  1081. },
  1082. {
  1083. "name": "offset",
  1084. "in": "query",
  1085. "description": "Offset for searching for groups",
  1086. "schema": {
  1087. "type": "integer",
  1088. "format": "int64",
  1089. "default": 0
  1090. }
  1091. },
  1092. {
  1093. "name": "OCS-APIRequest",
  1094. "in": "header",
  1095. "required": true,
  1096. "schema": {
  1097. "type": "string",
  1098. "default": "true"
  1099. }
  1100. }
  1101. ],
  1102. "responses": {
  1103. "200": {
  1104. "description": "",
  1105. "content": {
  1106. "application/json": {
  1107. "schema": {
  1108. "type": "object",
  1109. "required": [
  1110. "ocs"
  1111. ],
  1112. "properties": {
  1113. "ocs": {
  1114. "type": "object",
  1115. "required": [
  1116. "meta",
  1117. "data"
  1118. ],
  1119. "properties": {
  1120. "meta": {
  1121. "$ref": "#/components/schemas/OCSMeta"
  1122. },
  1123. "data": {
  1124. "type": "object",
  1125. "required": [
  1126. "groups"
  1127. ],
  1128. "properties": {
  1129. "groups": {
  1130. "type": "array",
  1131. "items": {
  1132. "$ref": "#/components/schemas/GroupDetails"
  1133. }
  1134. }
  1135. }
  1136. }
  1137. }
  1138. }
  1139. }
  1140. }
  1141. }
  1142. }
  1143. }
  1144. }
  1145. }
  1146. },
  1147. "/ocs/v2.php/cloud/groups/{groupId}/users": {
  1148. "get": {
  1149. "operationId": "groups-get-group-users",
  1150. "summary": "Get a list of users in the specified group",
  1151. "tags": [
  1152. "groups"
  1153. ],
  1154. "security": [
  1155. {
  1156. "bearer_auth": []
  1157. },
  1158. {
  1159. "basic_auth": []
  1160. }
  1161. ],
  1162. "parameters": [
  1163. {
  1164. "name": "groupId",
  1165. "in": "path",
  1166. "description": "ID of the group",
  1167. "required": true,
  1168. "schema": {
  1169. "type": "string",
  1170. "pattern": "^.+$"
  1171. }
  1172. },
  1173. {
  1174. "name": "OCS-APIRequest",
  1175. "in": "header",
  1176. "required": true,
  1177. "schema": {
  1178. "type": "string",
  1179. "default": "true"
  1180. }
  1181. }
  1182. ],
  1183. "responses": {
  1184. "200": {
  1185. "description": "User IDs returned",
  1186. "content": {
  1187. "application/json": {
  1188. "schema": {
  1189. "type": "object",
  1190. "required": [
  1191. "ocs"
  1192. ],
  1193. "properties": {
  1194. "ocs": {
  1195. "type": "object",
  1196. "required": [
  1197. "meta",
  1198. "data"
  1199. ],
  1200. "properties": {
  1201. "meta": {
  1202. "$ref": "#/components/schemas/OCSMeta"
  1203. },
  1204. "data": {
  1205. "type": "object",
  1206. "required": [
  1207. "users"
  1208. ],
  1209. "properties": {
  1210. "users": {
  1211. "type": "array",
  1212. "items": {
  1213. "type": "string"
  1214. }
  1215. }
  1216. }
  1217. }
  1218. }
  1219. }
  1220. }
  1221. }
  1222. }
  1223. }
  1224. },
  1225. "404": {
  1226. "description": "Group not found",
  1227. "content": {
  1228. "text/plain": {
  1229. "schema": {
  1230. "type": "string"
  1231. }
  1232. }
  1233. }
  1234. },
  1235. "403": {
  1236. "description": "Missing permissions to get users in the group",
  1237. "content": {
  1238. "text/plain": {
  1239. "schema": {
  1240. "type": "string"
  1241. }
  1242. }
  1243. }
  1244. }
  1245. }
  1246. }
  1247. },
  1248. "/ocs/v2.php/cloud/groups/{groupId}/users/details": {
  1249. "get": {
  1250. "operationId": "groups-get-group-users-details",
  1251. "summary": "Get a list of users details in the specified group",
  1252. "tags": [
  1253. "groups"
  1254. ],
  1255. "security": [
  1256. {
  1257. "bearer_auth": []
  1258. },
  1259. {
  1260. "basic_auth": []
  1261. }
  1262. ],
  1263. "parameters": [
  1264. {
  1265. "name": "search",
  1266. "in": "query",
  1267. "description": "Text to search for",
  1268. "schema": {
  1269. "type": "string",
  1270. "default": ""
  1271. }
  1272. },
  1273. {
  1274. "name": "limit",
  1275. "in": "query",
  1276. "description": "Limit the amount of groups returned",
  1277. "schema": {
  1278. "type": "integer",
  1279. "format": "int64",
  1280. "nullable": true
  1281. }
  1282. },
  1283. {
  1284. "name": "offset",
  1285. "in": "query",
  1286. "description": "Offset for searching for groups",
  1287. "schema": {
  1288. "type": "integer",
  1289. "format": "int64",
  1290. "default": 0
  1291. }
  1292. },
  1293. {
  1294. "name": "groupId",
  1295. "in": "path",
  1296. "description": "ID of the group",
  1297. "required": true,
  1298. "schema": {
  1299. "type": "string",
  1300. "pattern": "^.+$"
  1301. }
  1302. },
  1303. {
  1304. "name": "OCS-APIRequest",
  1305. "in": "header",
  1306. "required": true,
  1307. "schema": {
  1308. "type": "string",
  1309. "default": "true"
  1310. }
  1311. }
  1312. ],
  1313. "responses": {
  1314. "200": {
  1315. "description": "",
  1316. "content": {
  1317. "application/json": {
  1318. "schema": {
  1319. "type": "object",
  1320. "required": [
  1321. "ocs"
  1322. ],
  1323. "properties": {
  1324. "ocs": {
  1325. "type": "object",
  1326. "required": [
  1327. "meta",
  1328. "data"
  1329. ],
  1330. "properties": {
  1331. "meta": {
  1332. "$ref": "#/components/schemas/OCSMeta"
  1333. },
  1334. "data": {
  1335. "type": "object",
  1336. "required": [
  1337. "users"
  1338. ],
  1339. "properties": {
  1340. "users": {
  1341. "type": "object",
  1342. "additionalProperties": {
  1343. "oneOf": [
  1344. {
  1345. "$ref": "#/components/schemas/UserDetails"
  1346. },
  1347. {
  1348. "type": "object",
  1349. "required": [
  1350. "id"
  1351. ],
  1352. "properties": {
  1353. "id": {
  1354. "type": "string"
  1355. }
  1356. }
  1357. }
  1358. ]
  1359. }
  1360. }
  1361. }
  1362. }
  1363. }
  1364. }
  1365. }
  1366. }
  1367. }
  1368. }
  1369. }
  1370. }
  1371. }
  1372. },
  1373. "/ocs/v2.php/cloud/groups/{groupId}/subadmins": {
  1374. "get": {
  1375. "operationId": "groups-get-sub-admins-of-group",
  1376. "summary": "Get the list of user IDs that are a subadmin of the group",
  1377. "description": "This endpoint requires admin access",
  1378. "tags": [
  1379. "groups"
  1380. ],
  1381. "security": [
  1382. {
  1383. "bearer_auth": []
  1384. },
  1385. {
  1386. "basic_auth": []
  1387. }
  1388. ],
  1389. "parameters": [
  1390. {
  1391. "name": "groupId",
  1392. "in": "path",
  1393. "description": "ID of the group",
  1394. "required": true,
  1395. "schema": {
  1396. "type": "string",
  1397. "pattern": "^.+$"
  1398. }
  1399. },
  1400. {
  1401. "name": "OCS-APIRequest",
  1402. "in": "header",
  1403. "required": true,
  1404. "schema": {
  1405. "type": "string",
  1406. "default": "true"
  1407. }
  1408. }
  1409. ],
  1410. "responses": {
  1411. "200": {
  1412. "description": "",
  1413. "content": {
  1414. "application/json": {
  1415. "schema": {
  1416. "type": "object",
  1417. "required": [
  1418. "ocs"
  1419. ],
  1420. "properties": {
  1421. "ocs": {
  1422. "type": "object",
  1423. "required": [
  1424. "meta",
  1425. "data"
  1426. ],
  1427. "properties": {
  1428. "meta": {
  1429. "$ref": "#/components/schemas/OCSMeta"
  1430. },
  1431. "data": {
  1432. "type": "array",
  1433. "items": {
  1434. "type": "string"
  1435. }
  1436. }
  1437. }
  1438. }
  1439. }
  1440. }
  1441. }
  1442. }
  1443. }
  1444. }
  1445. }
  1446. },
  1447. "/ocs/v2.php/cloud/groups/{groupId}": {
  1448. "get": {
  1449. "operationId": "groups-get-group",
  1450. "summary": "Get a list of users in the specified group",
  1451. "deprecated": true,
  1452. "tags": [
  1453. "groups"
  1454. ],
  1455. "security": [
  1456. {
  1457. "bearer_auth": []
  1458. },
  1459. {
  1460. "basic_auth": []
  1461. }
  1462. ],
  1463. "parameters": [
  1464. {
  1465. "name": "groupId",
  1466. "in": "path",
  1467. "description": "ID of the group",
  1468. "required": true,
  1469. "schema": {
  1470. "type": "string",
  1471. "pattern": "^.+$"
  1472. }
  1473. },
  1474. {
  1475. "name": "OCS-APIRequest",
  1476. "in": "header",
  1477. "required": true,
  1478. "schema": {
  1479. "type": "string",
  1480. "default": "true"
  1481. }
  1482. }
  1483. ],
  1484. "responses": {
  1485. "200": {
  1486. "description": "",
  1487. "content": {
  1488. "application/json": {
  1489. "schema": {
  1490. "type": "object",
  1491. "required": [
  1492. "ocs"
  1493. ],
  1494. "properties": {
  1495. "ocs": {
  1496. "type": "object",
  1497. "required": [
  1498. "meta",
  1499. "data"
  1500. ],
  1501. "properties": {
  1502. "meta": {
  1503. "$ref": "#/components/schemas/OCSMeta"
  1504. },
  1505. "data": {
  1506. "type": "object",
  1507. "required": [
  1508. "users"
  1509. ],
  1510. "properties": {
  1511. "users": {
  1512. "type": "array",
  1513. "items": {
  1514. "type": "string"
  1515. }
  1516. }
  1517. }
  1518. }
  1519. }
  1520. }
  1521. }
  1522. }
  1523. }
  1524. }
  1525. }
  1526. }
  1527. },
  1528. "put": {
  1529. "operationId": "groups-update-group",
  1530. "summary": "Update a group",
  1531. "description": "This endpoint requires admin access",
  1532. "tags": [
  1533. "groups"
  1534. ],
  1535. "security": [
  1536. {
  1537. "bearer_auth": []
  1538. },
  1539. {
  1540. "basic_auth": []
  1541. }
  1542. ],
  1543. "parameters": [
  1544. {
  1545. "name": "key",
  1546. "in": "query",
  1547. "description": "Key to update, only 'displayname'",
  1548. "required": true,
  1549. "schema": {
  1550. "type": "string"
  1551. }
  1552. },
  1553. {
  1554. "name": "value",
  1555. "in": "query",
  1556. "description": "New value for the key",
  1557. "required": true,
  1558. "schema": {
  1559. "type": "string"
  1560. }
  1561. },
  1562. {
  1563. "name": "groupId",
  1564. "in": "path",
  1565. "description": "ID of the group",
  1566. "required": true,
  1567. "schema": {
  1568. "type": "string",
  1569. "pattern": "^.+$"
  1570. }
  1571. },
  1572. {
  1573. "name": "OCS-APIRequest",
  1574. "in": "header",
  1575. "required": true,
  1576. "schema": {
  1577. "type": "string",
  1578. "default": "true"
  1579. }
  1580. }
  1581. ],
  1582. "responses": {
  1583. "200": {
  1584. "description": "",
  1585. "content": {
  1586. "application/json": {
  1587. "schema": {
  1588. "type": "object",
  1589. "required": [
  1590. "ocs"
  1591. ],
  1592. "properties": {
  1593. "ocs": {
  1594. "type": "object",
  1595. "required": [
  1596. "meta",
  1597. "data"
  1598. ],
  1599. "properties": {
  1600. "meta": {
  1601. "$ref": "#/components/schemas/OCSMeta"
  1602. },
  1603. "data": {
  1604. "type": "object",
  1605. "additionalProperties": true
  1606. }
  1607. }
  1608. }
  1609. }
  1610. }
  1611. }
  1612. }
  1613. }
  1614. }
  1615. },
  1616. "delete": {
  1617. "operationId": "groups-delete-group",
  1618. "summary": "Delete a group",
  1619. "description": "This endpoint requires admin access",
  1620. "tags": [
  1621. "groups"
  1622. ],
  1623. "security": [
  1624. {
  1625. "bearer_auth": []
  1626. },
  1627. {
  1628. "basic_auth": []
  1629. }
  1630. ],
  1631. "parameters": [
  1632. {
  1633. "name": "groupId",
  1634. "in": "path",
  1635. "description": "ID of the group",
  1636. "required": true,
  1637. "schema": {
  1638. "type": "string",
  1639. "pattern": "^.+$"
  1640. }
  1641. },
  1642. {
  1643. "name": "OCS-APIRequest",
  1644. "in": "header",
  1645. "required": true,
  1646. "schema": {
  1647. "type": "string",
  1648. "default": "true"
  1649. }
  1650. }
  1651. ],
  1652. "responses": {
  1653. "200": {
  1654. "description": "",
  1655. "content": {
  1656. "application/json": {
  1657. "schema": {
  1658. "type": "object",
  1659. "required": [
  1660. "ocs"
  1661. ],
  1662. "properties": {
  1663. "ocs": {
  1664. "type": "object",
  1665. "required": [
  1666. "meta",
  1667. "data"
  1668. ],
  1669. "properties": {
  1670. "meta": {
  1671. "$ref": "#/components/schemas/OCSMeta"
  1672. },
  1673. "data": {
  1674. "type": "object",
  1675. "additionalProperties": true
  1676. }
  1677. }
  1678. }
  1679. }
  1680. }
  1681. }
  1682. }
  1683. }
  1684. }
  1685. }
  1686. },
  1687. "/ocs/v2.php/cloud/users": {
  1688. "get": {
  1689. "operationId": "users-get-users",
  1690. "summary": "Get a list of users",
  1691. "tags": [
  1692. "users"
  1693. ],
  1694. "security": [
  1695. {
  1696. "bearer_auth": []
  1697. },
  1698. {
  1699. "basic_auth": []
  1700. }
  1701. ],
  1702. "parameters": [
  1703. {
  1704. "name": "search",
  1705. "in": "query",
  1706. "description": "Text to search for",
  1707. "schema": {
  1708. "type": "string",
  1709. "default": ""
  1710. }
  1711. },
  1712. {
  1713. "name": "limit",
  1714. "in": "query",
  1715. "description": "Limit the amount of groups returned",
  1716. "schema": {
  1717. "type": "integer",
  1718. "format": "int64",
  1719. "nullable": true
  1720. }
  1721. },
  1722. {
  1723. "name": "offset",
  1724. "in": "query",
  1725. "description": "Offset for searching for groups",
  1726. "schema": {
  1727. "type": "integer",
  1728. "format": "int64",
  1729. "default": 0
  1730. }
  1731. },
  1732. {
  1733. "name": "OCS-APIRequest",
  1734. "in": "header",
  1735. "required": true,
  1736. "schema": {
  1737. "type": "string",
  1738. "default": "true"
  1739. }
  1740. }
  1741. ],
  1742. "responses": {
  1743. "200": {
  1744. "description": "",
  1745. "content": {
  1746. "application/json": {
  1747. "schema": {
  1748. "type": "object",
  1749. "required": [
  1750. "ocs"
  1751. ],
  1752. "properties": {
  1753. "ocs": {
  1754. "type": "object",
  1755. "required": [
  1756. "meta",
  1757. "data"
  1758. ],
  1759. "properties": {
  1760. "meta": {
  1761. "$ref": "#/components/schemas/OCSMeta"
  1762. },
  1763. "data": {
  1764. "type": "object",
  1765. "required": [
  1766. "users"
  1767. ],
  1768. "properties": {
  1769. "users": {
  1770. "type": "array",
  1771. "items": {
  1772. "type": "string"
  1773. }
  1774. }
  1775. }
  1776. }
  1777. }
  1778. }
  1779. }
  1780. }
  1781. }
  1782. }
  1783. }
  1784. }
  1785. },
  1786. "post": {
  1787. "operationId": "users-add-user",
  1788. "summary": "Create a new user",
  1789. "tags": [
  1790. "users"
  1791. ],
  1792. "security": [
  1793. {
  1794. "bearer_auth": []
  1795. },
  1796. {
  1797. "basic_auth": []
  1798. }
  1799. ],
  1800. "parameters": [
  1801. {
  1802. "name": "userid",
  1803. "in": "query",
  1804. "description": "ID of the user",
  1805. "required": true,
  1806. "schema": {
  1807. "type": "string"
  1808. }
  1809. },
  1810. {
  1811. "name": "password",
  1812. "in": "query",
  1813. "description": "Password of the user",
  1814. "schema": {
  1815. "type": "string",
  1816. "default": ""
  1817. }
  1818. },
  1819. {
  1820. "name": "displayName",
  1821. "in": "query",
  1822. "description": "Display name of the user",
  1823. "schema": {
  1824. "type": "string",
  1825. "default": ""
  1826. }
  1827. },
  1828. {
  1829. "name": "email",
  1830. "in": "query",
  1831. "description": "Email of the user",
  1832. "schema": {
  1833. "type": "string",
  1834. "default": ""
  1835. }
  1836. },
  1837. {
  1838. "name": "groups",
  1839. "in": "query",
  1840. "description": "Groups of the user",
  1841. "schema": {
  1842. "type": "string"
  1843. }
  1844. },
  1845. {
  1846. "name": "subadmin",
  1847. "in": "query",
  1848. "description": "Groups where the user is subadmin",
  1849. "schema": {
  1850. "type": "string"
  1851. }
  1852. },
  1853. {
  1854. "name": "quota",
  1855. "in": "query",
  1856. "description": "Quota of the user",
  1857. "schema": {
  1858. "type": "string",
  1859. "default": ""
  1860. }
  1861. },
  1862. {
  1863. "name": "language",
  1864. "in": "query",
  1865. "description": "Language of the user",
  1866. "schema": {
  1867. "type": "string",
  1868. "default": ""
  1869. }
  1870. },
  1871. {
  1872. "name": "manager",
  1873. "in": "query",
  1874. "description": "Manager of the user",
  1875. "schema": {
  1876. "type": "string",
  1877. "nullable": true
  1878. }
  1879. },
  1880. {
  1881. "name": "OCS-APIRequest",
  1882. "in": "header",
  1883. "required": true,
  1884. "schema": {
  1885. "type": "string",
  1886. "default": "true"
  1887. }
  1888. }
  1889. ],
  1890. "responses": {
  1891. "200": {
  1892. "description": "User added successfully",
  1893. "content": {
  1894. "application/json": {
  1895. "schema": {
  1896. "type": "object",
  1897. "required": [
  1898. "ocs"
  1899. ],
  1900. "properties": {
  1901. "ocs": {
  1902. "type": "object",
  1903. "required": [
  1904. "meta",
  1905. "data"
  1906. ],
  1907. "properties": {
  1908. "meta": {
  1909. "$ref": "#/components/schemas/OCSMeta"
  1910. },
  1911. "data": {
  1912. "type": "object",
  1913. "required": [
  1914. "id"
  1915. ],
  1916. "properties": {
  1917. "id": {
  1918. "type": "string"
  1919. }
  1920. }
  1921. }
  1922. }
  1923. }
  1924. }
  1925. }
  1926. }
  1927. }
  1928. },
  1929. "403": {
  1930. "description": "Missing permissions to make user subadmin",
  1931. "content": {
  1932. "text/plain": {
  1933. "schema": {
  1934. "type": "string"
  1935. }
  1936. }
  1937. }
  1938. }
  1939. }
  1940. }
  1941. },
  1942. "/ocs/v2.php/cloud/users/details": {
  1943. "get": {
  1944. "operationId": "users-get-users-details",
  1945. "summary": "Get a list of users and their details",
  1946. "tags": [
  1947. "users"
  1948. ],
  1949. "security": [
  1950. {
  1951. "bearer_auth": []
  1952. },
  1953. {
  1954. "basic_auth": []
  1955. }
  1956. ],
  1957. "parameters": [
  1958. {
  1959. "name": "search",
  1960. "in": "query",
  1961. "description": "Text to search for",
  1962. "schema": {
  1963. "type": "string",
  1964. "default": ""
  1965. }
  1966. },
  1967. {
  1968. "name": "limit",
  1969. "in": "query",
  1970. "description": "Limit the amount of groups returned",
  1971. "schema": {
  1972. "type": "integer",
  1973. "format": "int64",
  1974. "nullable": true
  1975. }
  1976. },
  1977. {
  1978. "name": "offset",
  1979. "in": "query",
  1980. "description": "Offset for searching for groups",
  1981. "schema": {
  1982. "type": "integer",
  1983. "format": "int64",
  1984. "default": 0
  1985. }
  1986. },
  1987. {
  1988. "name": "OCS-APIRequest",
  1989. "in": "header",
  1990. "required": true,
  1991. "schema": {
  1992. "type": "string",
  1993. "default": "true"
  1994. }
  1995. }
  1996. ],
  1997. "responses": {
  1998. "200": {
  1999. "description": "",
  2000. "content": {
  2001. "application/json": {
  2002. "schema": {
  2003. "type": "object",
  2004. "required": [
  2005. "ocs"
  2006. ],
  2007. "properties": {
  2008. "ocs": {
  2009. "type": "object",
  2010. "required": [
  2011. "meta",
  2012. "data"
  2013. ],
  2014. "properties": {
  2015. "meta": {
  2016. "$ref": "#/components/schemas/OCSMeta"
  2017. },
  2018. "data": {
  2019. "type": "object",
  2020. "required": [
  2021. "users"
  2022. ],
  2023. "properties": {
  2024. "users": {
  2025. "type": "object",
  2026. "additionalProperties": {
  2027. "oneOf": [
  2028. {
  2029. "$ref": "#/components/schemas/UserDetails"
  2030. },
  2031. {
  2032. "type": "object",
  2033. "required": [
  2034. "id"
  2035. ],
  2036. "properties": {
  2037. "id": {
  2038. "type": "string"
  2039. }
  2040. }
  2041. }
  2042. ]
  2043. }
  2044. }
  2045. }
  2046. }
  2047. }
  2048. }
  2049. }
  2050. }
  2051. }
  2052. }
  2053. }
  2054. }
  2055. }
  2056. },
  2057. "/ocs/v2.php/cloud/users/search/by-phone": {
  2058. "post": {
  2059. "operationId": "users-search-by-phone-numbers",
  2060. "summary": "Search users by their phone numbers",
  2061. "tags": [
  2062. "users"
  2063. ],
  2064. "security": [
  2065. {
  2066. "bearer_auth": []
  2067. },
  2068. {
  2069. "basic_auth": []
  2070. }
  2071. ],
  2072. "parameters": [
  2073. {
  2074. "name": "location",
  2075. "in": "query",
  2076. "description": "Location of the phone number (for country code)",
  2077. "required": true,
  2078. "schema": {
  2079. "type": "string"
  2080. }
  2081. },
  2082. {
  2083. "name": "search",
  2084. "in": "query",
  2085. "description": "Phone numbers to search for",
  2086. "required": true,
  2087. "schema": {
  2088. "type": "string"
  2089. }
  2090. },
  2091. {
  2092. "name": "OCS-APIRequest",
  2093. "in": "header",
  2094. "required": true,
  2095. "schema": {
  2096. "type": "string",
  2097. "default": "true"
  2098. }
  2099. }
  2100. ],
  2101. "responses": {
  2102. "200": {
  2103. "description": "Users returned",
  2104. "content": {
  2105. "application/json": {
  2106. "schema": {
  2107. "type": "object",
  2108. "required": [
  2109. "ocs"
  2110. ],
  2111. "properties": {
  2112. "ocs": {
  2113. "type": "object",
  2114. "required": [
  2115. "meta",
  2116. "data"
  2117. ],
  2118. "properties": {
  2119. "meta": {
  2120. "$ref": "#/components/schemas/OCSMeta"
  2121. },
  2122. "data": {
  2123. "type": "object",
  2124. "additionalProperties": {
  2125. "type": "string"
  2126. }
  2127. }
  2128. }
  2129. }
  2130. }
  2131. }
  2132. }
  2133. }
  2134. },
  2135. "400": {
  2136. "description": "Invalid location",
  2137. "content": {
  2138. "application/json": {
  2139. "schema": {
  2140. "type": "object",
  2141. "required": [
  2142. "ocs"
  2143. ],
  2144. "properties": {
  2145. "ocs": {
  2146. "type": "object",
  2147. "required": [
  2148. "meta",
  2149. "data"
  2150. ],
  2151. "properties": {
  2152. "meta": {
  2153. "$ref": "#/components/schemas/OCSMeta"
  2154. },
  2155. "data": {
  2156. "type": "object",
  2157. "additionalProperties": true
  2158. }
  2159. }
  2160. }
  2161. }
  2162. }
  2163. }
  2164. }
  2165. }
  2166. }
  2167. }
  2168. },
  2169. "/ocs/v2.php/cloud/users/{userId}": {
  2170. "get": {
  2171. "operationId": "users-get-user",
  2172. "summary": "Get the details of a user",
  2173. "tags": [
  2174. "users"
  2175. ],
  2176. "security": [
  2177. {
  2178. "bearer_auth": []
  2179. },
  2180. {
  2181. "basic_auth": []
  2182. }
  2183. ],
  2184. "parameters": [
  2185. {
  2186. "name": "userId",
  2187. "in": "path",
  2188. "description": "ID of the user",
  2189. "required": true,
  2190. "schema": {
  2191. "type": "string"
  2192. }
  2193. },
  2194. {
  2195. "name": "OCS-APIRequest",
  2196. "in": "header",
  2197. "required": true,
  2198. "schema": {
  2199. "type": "string",
  2200. "default": "true"
  2201. }
  2202. }
  2203. ],
  2204. "responses": {
  2205. "200": {
  2206. "description": "",
  2207. "content": {
  2208. "application/json": {
  2209. "schema": {
  2210. "type": "object",
  2211. "required": [
  2212. "ocs"
  2213. ],
  2214. "properties": {
  2215. "ocs": {
  2216. "type": "object",
  2217. "required": [
  2218. "meta",
  2219. "data"
  2220. ],
  2221. "properties": {
  2222. "meta": {
  2223. "$ref": "#/components/schemas/OCSMeta"
  2224. },
  2225. "data": {
  2226. "$ref": "#/components/schemas/UserDetails"
  2227. }
  2228. }
  2229. }
  2230. }
  2231. }
  2232. }
  2233. }
  2234. }
  2235. }
  2236. },
  2237. "put": {
  2238. "operationId": "users-edit-user",
  2239. "summary": "Update a value of the user's details",
  2240. "tags": [
  2241. "users"
  2242. ],
  2243. "security": [
  2244. {
  2245. "bearer_auth": []
  2246. },
  2247. {
  2248. "basic_auth": []
  2249. }
  2250. ],
  2251. "parameters": [
  2252. {
  2253. "name": "key",
  2254. "in": "query",
  2255. "description": "Key that will be updated",
  2256. "required": true,
  2257. "schema": {
  2258. "type": "string"
  2259. }
  2260. },
  2261. {
  2262. "name": "value",
  2263. "in": "query",
  2264. "description": "New value for the key",
  2265. "required": true,
  2266. "schema": {
  2267. "type": "string"
  2268. }
  2269. },
  2270. {
  2271. "name": "userId",
  2272. "in": "path",
  2273. "description": "ID of the user",
  2274. "required": true,
  2275. "schema": {
  2276. "type": "string"
  2277. }
  2278. },
  2279. {
  2280. "name": "OCS-APIRequest",
  2281. "in": "header",
  2282. "required": true,
  2283. "schema": {
  2284. "type": "string",
  2285. "default": "true"
  2286. }
  2287. }
  2288. ],
  2289. "responses": {
  2290. "200": {
  2291. "description": "",
  2292. "content": {
  2293. "application/json": {
  2294. "schema": {
  2295. "type": "object",
  2296. "required": [
  2297. "ocs"
  2298. ],
  2299. "properties": {
  2300. "ocs": {
  2301. "type": "object",
  2302. "required": [
  2303. "meta",
  2304. "data"
  2305. ],
  2306. "properties": {
  2307. "meta": {
  2308. "$ref": "#/components/schemas/OCSMeta"
  2309. },
  2310. "data": {
  2311. "type": "object",
  2312. "additionalProperties": true
  2313. }
  2314. }
  2315. }
  2316. }
  2317. }
  2318. }
  2319. }
  2320. }
  2321. }
  2322. },
  2323. "delete": {
  2324. "operationId": "users-delete-user",
  2325. "summary": "Delete a user",
  2326. "tags": [
  2327. "users"
  2328. ],
  2329. "security": [
  2330. {
  2331. "bearer_auth": []
  2332. },
  2333. {
  2334. "basic_auth": []
  2335. }
  2336. ],
  2337. "parameters": [
  2338. {
  2339. "name": "userId",
  2340. "in": "path",
  2341. "description": "ID of the user",
  2342. "required": true,
  2343. "schema": {
  2344. "type": "string"
  2345. }
  2346. },
  2347. {
  2348. "name": "OCS-APIRequest",
  2349. "in": "header",
  2350. "required": true,
  2351. "schema": {
  2352. "type": "string",
  2353. "default": "true"
  2354. }
  2355. }
  2356. ],
  2357. "responses": {
  2358. "200": {
  2359. "description": "",
  2360. "content": {
  2361. "application/json": {
  2362. "schema": {
  2363. "type": "object",
  2364. "required": [
  2365. "ocs"
  2366. ],
  2367. "properties": {
  2368. "ocs": {
  2369. "type": "object",
  2370. "required": [
  2371. "meta",
  2372. "data"
  2373. ],
  2374. "properties": {
  2375. "meta": {
  2376. "$ref": "#/components/schemas/OCSMeta"
  2377. },
  2378. "data": {
  2379. "type": "object",
  2380. "additionalProperties": true
  2381. }
  2382. }
  2383. }
  2384. }
  2385. }
  2386. }
  2387. }
  2388. }
  2389. }
  2390. }
  2391. },
  2392. "/ocs/v2.php/cloud/user": {
  2393. "get": {
  2394. "operationId": "users-get-current-user",
  2395. "summary": "Get the details of the current user",
  2396. "tags": [
  2397. "users"
  2398. ],
  2399. "security": [
  2400. {
  2401. "bearer_auth": []
  2402. },
  2403. {
  2404. "basic_auth": []
  2405. }
  2406. ],
  2407. "parameters": [
  2408. {
  2409. "name": "OCS-APIRequest",
  2410. "in": "header",
  2411. "required": true,
  2412. "schema": {
  2413. "type": "string",
  2414. "default": "true"
  2415. }
  2416. }
  2417. ],
  2418. "responses": {
  2419. "200": {
  2420. "description": "",
  2421. "content": {
  2422. "application/json": {
  2423. "schema": {
  2424. "type": "object",
  2425. "required": [
  2426. "ocs"
  2427. ],
  2428. "properties": {
  2429. "ocs": {
  2430. "type": "object",
  2431. "required": [
  2432. "meta",
  2433. "data"
  2434. ],
  2435. "properties": {
  2436. "meta": {
  2437. "$ref": "#/components/schemas/OCSMeta"
  2438. },
  2439. "data": {
  2440. "$ref": "#/components/schemas/UserDetails"
  2441. }
  2442. }
  2443. }
  2444. }
  2445. }
  2446. }
  2447. }
  2448. }
  2449. }
  2450. }
  2451. },
  2452. "/ocs/v2.php/cloud/user/fields": {
  2453. "get": {
  2454. "operationId": "users-get-editable-fields",
  2455. "summary": "Get a list of fields that are editable for the current user",
  2456. "tags": [
  2457. "users"
  2458. ],
  2459. "security": [
  2460. {
  2461. "bearer_auth": []
  2462. },
  2463. {
  2464. "basic_auth": []
  2465. }
  2466. ],
  2467. "parameters": [
  2468. {
  2469. "name": "OCS-APIRequest",
  2470. "in": "header",
  2471. "required": true,
  2472. "schema": {
  2473. "type": "string",
  2474. "default": "true"
  2475. }
  2476. }
  2477. ],
  2478. "responses": {
  2479. "200": {
  2480. "description": "",
  2481. "content": {
  2482. "application/json": {
  2483. "schema": {
  2484. "type": "object",
  2485. "required": [
  2486. "ocs"
  2487. ],
  2488. "properties": {
  2489. "ocs": {
  2490. "type": "object",
  2491. "required": [
  2492. "meta",
  2493. "data"
  2494. ],
  2495. "properties": {
  2496. "meta": {
  2497. "$ref": "#/components/schemas/OCSMeta"
  2498. },
  2499. "data": {
  2500. "type": "array",
  2501. "items": {
  2502. "type": "string"
  2503. }
  2504. }
  2505. }
  2506. }
  2507. }
  2508. }
  2509. }
  2510. }
  2511. }
  2512. }
  2513. }
  2514. },
  2515. "/ocs/v2.php/cloud/user/fields/{userId}": {
  2516. "get": {
  2517. "operationId": "users-get-editable-fields-for-user",
  2518. "summary": "Get a list of fields that are editable for a user",
  2519. "tags": [
  2520. "users"
  2521. ],
  2522. "security": [
  2523. {
  2524. "bearer_auth": []
  2525. },
  2526. {
  2527. "basic_auth": []
  2528. }
  2529. ],
  2530. "parameters": [
  2531. {
  2532. "name": "userId",
  2533. "in": "path",
  2534. "description": "ID of the user",
  2535. "required": true,
  2536. "schema": {
  2537. "type": "string"
  2538. }
  2539. },
  2540. {
  2541. "name": "OCS-APIRequest",
  2542. "in": "header",
  2543. "required": true,
  2544. "schema": {
  2545. "type": "string",
  2546. "default": "true"
  2547. }
  2548. }
  2549. ],
  2550. "responses": {
  2551. "200": {
  2552. "description": "",
  2553. "content": {
  2554. "application/json": {
  2555. "schema": {
  2556. "type": "object",
  2557. "required": [
  2558. "ocs"
  2559. ],
  2560. "properties": {
  2561. "ocs": {
  2562. "type": "object",
  2563. "required": [
  2564. "meta",
  2565. "data"
  2566. ],
  2567. "properties": {
  2568. "meta": {
  2569. "$ref": "#/components/schemas/OCSMeta"
  2570. },
  2571. "data": {
  2572. "type": "array",
  2573. "items": {
  2574. "type": "string"
  2575. }
  2576. }
  2577. }
  2578. }
  2579. }
  2580. }
  2581. }
  2582. }
  2583. }
  2584. }
  2585. }
  2586. },
  2587. "/ocs/v2.php/cloud/users/{userId}/{collectionName}": {
  2588. "put": {
  2589. "operationId": "users-edit-user-multi-value",
  2590. "summary": "Update multiple values of the user's details",
  2591. "tags": [
  2592. "users"
  2593. ],
  2594. "security": [
  2595. {
  2596. "bearer_auth": []
  2597. },
  2598. {
  2599. "basic_auth": []
  2600. }
  2601. ],
  2602. "parameters": [
  2603. {
  2604. "name": "key",
  2605. "in": "query",
  2606. "description": "Key that will be updated",
  2607. "required": true,
  2608. "schema": {
  2609. "type": "string"
  2610. }
  2611. },
  2612. {
  2613. "name": "value",
  2614. "in": "query",
  2615. "description": "New value for the key",
  2616. "required": true,
  2617. "schema": {
  2618. "type": "string"
  2619. }
  2620. },
  2621. {
  2622. "name": "userId",
  2623. "in": "path",
  2624. "description": "ID of the user",
  2625. "required": true,
  2626. "schema": {
  2627. "type": "string"
  2628. }
  2629. },
  2630. {
  2631. "name": "collectionName",
  2632. "in": "path",
  2633. "description": "Collection to update",
  2634. "required": true,
  2635. "schema": {
  2636. "type": "string",
  2637. "pattern": "^(?!enable$|disable$)[a-zA-Z0-9_]*$"
  2638. }
  2639. },
  2640. {
  2641. "name": "OCS-APIRequest",
  2642. "in": "header",
  2643. "required": true,
  2644. "schema": {
  2645. "type": "string",
  2646. "default": "true"
  2647. }
  2648. }
  2649. ],
  2650. "responses": {
  2651. "200": {
  2652. "description": "",
  2653. "content": {
  2654. "application/json": {
  2655. "schema": {
  2656. "type": "object",
  2657. "required": [
  2658. "ocs"
  2659. ],
  2660. "properties": {
  2661. "ocs": {
  2662. "type": "object",
  2663. "required": [
  2664. "meta",
  2665. "data"
  2666. ],
  2667. "properties": {
  2668. "meta": {
  2669. "$ref": "#/components/schemas/OCSMeta"
  2670. },
  2671. "data": {
  2672. "type": "object",
  2673. "additionalProperties": true
  2674. }
  2675. }
  2676. }
  2677. }
  2678. }
  2679. }
  2680. }
  2681. }
  2682. }
  2683. }
  2684. },
  2685. "/ocs/v2.php/cloud/users/{userId}/wipe": {
  2686. "post": {
  2687. "operationId": "users-wipe-user-devices",
  2688. "summary": "Wipe all devices of a user",
  2689. "tags": [
  2690. "users"
  2691. ],
  2692. "security": [
  2693. {
  2694. "bearer_auth": []
  2695. },
  2696. {
  2697. "basic_auth": []
  2698. }
  2699. ],
  2700. "parameters": [
  2701. {
  2702. "name": "userId",
  2703. "in": "path",
  2704. "description": "ID of the user",
  2705. "required": true,
  2706. "schema": {
  2707. "type": "string"
  2708. }
  2709. },
  2710. {
  2711. "name": "OCS-APIRequest",
  2712. "in": "header",
  2713. "required": true,
  2714. "schema": {
  2715. "type": "string",
  2716. "default": "true"
  2717. }
  2718. }
  2719. ],
  2720. "responses": {
  2721. "200": {
  2722. "description": "",
  2723. "content": {
  2724. "application/json": {
  2725. "schema": {
  2726. "type": "object",
  2727. "required": [
  2728. "ocs"
  2729. ],
  2730. "properties": {
  2731. "ocs": {
  2732. "type": "object",
  2733. "required": [
  2734. "meta",
  2735. "data"
  2736. ],
  2737. "properties": {
  2738. "meta": {
  2739. "$ref": "#/components/schemas/OCSMeta"
  2740. },
  2741. "data": {
  2742. "type": "object",
  2743. "additionalProperties": true
  2744. }
  2745. }
  2746. }
  2747. }
  2748. }
  2749. }
  2750. }
  2751. }
  2752. }
  2753. }
  2754. },
  2755. "/ocs/v2.php/cloud/users/{userId}/enable": {
  2756. "put": {
  2757. "operationId": "users-enable-user",
  2758. "summary": "Enable a user",
  2759. "tags": [
  2760. "users"
  2761. ],
  2762. "security": [
  2763. {
  2764. "bearer_auth": []
  2765. },
  2766. {
  2767. "basic_auth": []
  2768. }
  2769. ],
  2770. "parameters": [
  2771. {
  2772. "name": "userId",
  2773. "in": "path",
  2774. "description": "ID of the user",
  2775. "required": true,
  2776. "schema": {
  2777. "type": "string"
  2778. }
  2779. },
  2780. {
  2781. "name": "OCS-APIRequest",
  2782. "in": "header",
  2783. "required": true,
  2784. "schema": {
  2785. "type": "string",
  2786. "default": "true"
  2787. }
  2788. }
  2789. ],
  2790. "responses": {
  2791. "200": {
  2792. "description": "",
  2793. "content": {
  2794. "application/json": {
  2795. "schema": {
  2796. "type": "object",
  2797. "required": [
  2798. "ocs"
  2799. ],
  2800. "properties": {
  2801. "ocs": {
  2802. "type": "object",
  2803. "required": [
  2804. "meta",
  2805. "data"
  2806. ],
  2807. "properties": {
  2808. "meta": {
  2809. "$ref": "#/components/schemas/OCSMeta"
  2810. },
  2811. "data": {
  2812. "type": "object",
  2813. "additionalProperties": true
  2814. }
  2815. }
  2816. }
  2817. }
  2818. }
  2819. }
  2820. }
  2821. }
  2822. }
  2823. }
  2824. },
  2825. "/ocs/v2.php/cloud/users/{userId}/disable": {
  2826. "put": {
  2827. "operationId": "users-disable-user",
  2828. "summary": "Disable a user",
  2829. "tags": [
  2830. "users"
  2831. ],
  2832. "security": [
  2833. {
  2834. "bearer_auth": []
  2835. },
  2836. {
  2837. "basic_auth": []
  2838. }
  2839. ],
  2840. "parameters": [
  2841. {
  2842. "name": "userId",
  2843. "in": "path",
  2844. "description": "ID of the user",
  2845. "required": true,
  2846. "schema": {
  2847. "type": "string"
  2848. }
  2849. },
  2850. {
  2851. "name": "OCS-APIRequest",
  2852. "in": "header",
  2853. "required": true,
  2854. "schema": {
  2855. "type": "string",
  2856. "default": "true"
  2857. }
  2858. }
  2859. ],
  2860. "responses": {
  2861. "200": {
  2862. "description": "",
  2863. "content": {
  2864. "application/json": {
  2865. "schema": {
  2866. "type": "object",
  2867. "required": [
  2868. "ocs"
  2869. ],
  2870. "properties": {
  2871. "ocs": {
  2872. "type": "object",
  2873. "required": [
  2874. "meta",
  2875. "data"
  2876. ],
  2877. "properties": {
  2878. "meta": {
  2879. "$ref": "#/components/schemas/OCSMeta"
  2880. },
  2881. "data": {
  2882. "type": "object",
  2883. "additionalProperties": true
  2884. }
  2885. }
  2886. }
  2887. }
  2888. }
  2889. }
  2890. }
  2891. }
  2892. }
  2893. }
  2894. },
  2895. "/ocs/v2.php/cloud/users/{userId}/groups": {
  2896. "get": {
  2897. "operationId": "users-get-users-groups",
  2898. "summary": "Get a list of groups the user belongs to",
  2899. "tags": [
  2900. "users"
  2901. ],
  2902. "security": [
  2903. {
  2904. "bearer_auth": []
  2905. },
  2906. {
  2907. "basic_auth": []
  2908. }
  2909. ],
  2910. "parameters": [
  2911. {
  2912. "name": "userId",
  2913. "in": "path",
  2914. "description": "ID of the user",
  2915. "required": true,
  2916. "schema": {
  2917. "type": "string"
  2918. }
  2919. },
  2920. {
  2921. "name": "OCS-APIRequest",
  2922. "in": "header",
  2923. "required": true,
  2924. "schema": {
  2925. "type": "string",
  2926. "default": "true"
  2927. }
  2928. }
  2929. ],
  2930. "responses": {
  2931. "200": {
  2932. "description": "",
  2933. "content": {
  2934. "application/json": {
  2935. "schema": {
  2936. "type": "object",
  2937. "required": [
  2938. "ocs"
  2939. ],
  2940. "properties": {
  2941. "ocs": {
  2942. "type": "object",
  2943. "required": [
  2944. "meta",
  2945. "data"
  2946. ],
  2947. "properties": {
  2948. "meta": {
  2949. "$ref": "#/components/schemas/OCSMeta"
  2950. },
  2951. "data": {
  2952. "type": "object",
  2953. "required": [
  2954. "groups"
  2955. ],
  2956. "properties": {
  2957. "groups": {
  2958. "type": "array",
  2959. "items": {
  2960. "type": "string"
  2961. }
  2962. }
  2963. }
  2964. }
  2965. }
  2966. }
  2967. }
  2968. }
  2969. }
  2970. }
  2971. }
  2972. }
  2973. },
  2974. "post": {
  2975. "operationId": "users-add-to-group",
  2976. "summary": "Add a user to a group",
  2977. "tags": [
  2978. "users"
  2979. ],
  2980. "security": [
  2981. {
  2982. "bearer_auth": []
  2983. },
  2984. {
  2985. "basic_auth": []
  2986. }
  2987. ],
  2988. "parameters": [
  2989. {
  2990. "name": "groupid",
  2991. "in": "query",
  2992. "description": "ID of the group",
  2993. "schema": {
  2994. "type": "string",
  2995. "default": ""
  2996. }
  2997. },
  2998. {
  2999. "name": "userId",
  3000. "in": "path",
  3001. "description": "ID of the user",
  3002. "required": true,
  3003. "schema": {
  3004. "type": "string"
  3005. }
  3006. },
  3007. {
  3008. "name": "OCS-APIRequest",
  3009. "in": "header",
  3010. "required": true,
  3011. "schema": {
  3012. "type": "string",
  3013. "default": "true"
  3014. }
  3015. }
  3016. ],
  3017. "responses": {
  3018. "200": {
  3019. "description": "",
  3020. "content": {
  3021. "application/json": {
  3022. "schema": {
  3023. "type": "object",
  3024. "required": [
  3025. "ocs"
  3026. ],
  3027. "properties": {
  3028. "ocs": {
  3029. "type": "object",
  3030. "required": [
  3031. "meta",
  3032. "data"
  3033. ],
  3034. "properties": {
  3035. "meta": {
  3036. "$ref": "#/components/schemas/OCSMeta"
  3037. },
  3038. "data": {
  3039. "type": "object",
  3040. "additionalProperties": true
  3041. }
  3042. }
  3043. }
  3044. }
  3045. }
  3046. }
  3047. }
  3048. }
  3049. }
  3050. },
  3051. "delete": {
  3052. "operationId": "users-remove-from-group",
  3053. "summary": "Remove a user from a group",
  3054. "tags": [
  3055. "users"
  3056. ],
  3057. "security": [
  3058. {
  3059. "bearer_auth": []
  3060. },
  3061. {
  3062. "basic_auth": []
  3063. }
  3064. ],
  3065. "parameters": [
  3066. {
  3067. "name": "groupid",
  3068. "in": "query",
  3069. "description": "ID of the group",
  3070. "required": true,
  3071. "schema": {
  3072. "type": "string"
  3073. }
  3074. },
  3075. {
  3076. "name": "userId",
  3077. "in": "path",
  3078. "description": "ID of the user",
  3079. "required": true,
  3080. "schema": {
  3081. "type": "string"
  3082. }
  3083. },
  3084. {
  3085. "name": "OCS-APIRequest",
  3086. "in": "header",
  3087. "required": true,
  3088. "schema": {
  3089. "type": "string",
  3090. "default": "true"
  3091. }
  3092. }
  3093. ],
  3094. "responses": {
  3095. "200": {
  3096. "description": "",
  3097. "content": {
  3098. "application/json": {
  3099. "schema": {
  3100. "type": "object",
  3101. "required": [
  3102. "ocs"
  3103. ],
  3104. "properties": {
  3105. "ocs": {
  3106. "type": "object",
  3107. "required": [
  3108. "meta",
  3109. "data"
  3110. ],
  3111. "properties": {
  3112. "meta": {
  3113. "$ref": "#/components/schemas/OCSMeta"
  3114. },
  3115. "data": {
  3116. "type": "object",
  3117. "additionalProperties": true
  3118. }
  3119. }
  3120. }
  3121. }
  3122. }
  3123. }
  3124. }
  3125. }
  3126. }
  3127. }
  3128. },
  3129. "/ocs/v2.php/cloud/users/{userId}/subadmins": {
  3130. "get": {
  3131. "operationId": "users-get-user-sub-admin-groups",
  3132. "summary": "Get the groups a user is a subadmin of",
  3133. "description": "This endpoint requires admin access",
  3134. "tags": [
  3135. "users"
  3136. ],
  3137. "security": [
  3138. {
  3139. "bearer_auth": []
  3140. },
  3141. {
  3142. "basic_auth": []
  3143. }
  3144. ],
  3145. "parameters": [
  3146. {
  3147. "name": "userId",
  3148. "in": "path",
  3149. "description": "ID if the user",
  3150. "required": true,
  3151. "schema": {
  3152. "type": "string"
  3153. }
  3154. },
  3155. {
  3156. "name": "OCS-APIRequest",
  3157. "in": "header",
  3158. "required": true,
  3159. "schema": {
  3160. "type": "string",
  3161. "default": "true"
  3162. }
  3163. }
  3164. ],
  3165. "responses": {
  3166. "200": {
  3167. "description": "",
  3168. "content": {
  3169. "application/json": {
  3170. "schema": {
  3171. "type": "object",
  3172. "required": [
  3173. "ocs"
  3174. ],
  3175. "properties": {
  3176. "ocs": {
  3177. "type": "object",
  3178. "required": [
  3179. "meta",
  3180. "data"
  3181. ],
  3182. "properties": {
  3183. "meta": {
  3184. "$ref": "#/components/schemas/OCSMeta"
  3185. },
  3186. "data": {
  3187. "type": "array",
  3188. "items": {
  3189. "type": "string"
  3190. }
  3191. }
  3192. }
  3193. }
  3194. }
  3195. }
  3196. }
  3197. }
  3198. }
  3199. }
  3200. },
  3201. "post": {
  3202. "operationId": "users-add-sub-admin",
  3203. "summary": "Make a user a subadmin of a group",
  3204. "description": "This endpoint requires admin access",
  3205. "tags": [
  3206. "users"
  3207. ],
  3208. "security": [
  3209. {
  3210. "bearer_auth": []
  3211. },
  3212. {
  3213. "basic_auth": []
  3214. }
  3215. ],
  3216. "parameters": [
  3217. {
  3218. "name": "groupid",
  3219. "in": "query",
  3220. "description": "ID of the group",
  3221. "required": true,
  3222. "schema": {
  3223. "type": "string"
  3224. }
  3225. },
  3226. {
  3227. "name": "userId",
  3228. "in": "path",
  3229. "description": "ID of the user",
  3230. "required": true,
  3231. "schema": {
  3232. "type": "string"
  3233. }
  3234. },
  3235. {
  3236. "name": "OCS-APIRequest",
  3237. "in": "header",
  3238. "required": true,
  3239. "schema": {
  3240. "type": "string",
  3241. "default": "true"
  3242. }
  3243. }
  3244. ],
  3245. "responses": {
  3246. "200": {
  3247. "description": "",
  3248. "content": {
  3249. "application/json": {
  3250. "schema": {
  3251. "type": "object",
  3252. "required": [
  3253. "ocs"
  3254. ],
  3255. "properties": {
  3256. "ocs": {
  3257. "type": "object",
  3258. "required": [
  3259. "meta",
  3260. "data"
  3261. ],
  3262. "properties": {
  3263. "meta": {
  3264. "$ref": "#/components/schemas/OCSMeta"
  3265. },
  3266. "data": {
  3267. "type": "object",
  3268. "additionalProperties": true
  3269. }
  3270. }
  3271. }
  3272. }
  3273. }
  3274. }
  3275. }
  3276. }
  3277. }
  3278. },
  3279. "delete": {
  3280. "operationId": "users-remove-sub-admin",
  3281. "summary": "Remove a user from the subadmins of a group",
  3282. "description": "This endpoint requires admin access",
  3283. "tags": [
  3284. "users"
  3285. ],
  3286. "security": [
  3287. {
  3288. "bearer_auth": []
  3289. },
  3290. {
  3291. "basic_auth": []
  3292. }
  3293. ],
  3294. "parameters": [
  3295. {
  3296. "name": "groupid",
  3297. "in": "query",
  3298. "description": "ID of the group",
  3299. "required": true,
  3300. "schema": {
  3301. "type": "string"
  3302. }
  3303. },
  3304. {
  3305. "name": "userId",
  3306. "in": "path",
  3307. "description": "ID of the user",
  3308. "required": true,
  3309. "schema": {
  3310. "type": "string"
  3311. }
  3312. },
  3313. {
  3314. "name": "OCS-APIRequest",
  3315. "in": "header",
  3316. "required": true,
  3317. "schema": {
  3318. "type": "string",
  3319. "default": "true"
  3320. }
  3321. }
  3322. ],
  3323. "responses": {
  3324. "200": {
  3325. "description": "",
  3326. "content": {
  3327. "application/json": {
  3328. "schema": {
  3329. "type": "object",
  3330. "required": [
  3331. "ocs"
  3332. ],
  3333. "properties": {
  3334. "ocs": {
  3335. "type": "object",
  3336. "required": [
  3337. "meta",
  3338. "data"
  3339. ],
  3340. "properties": {
  3341. "meta": {
  3342. "$ref": "#/components/schemas/OCSMeta"
  3343. },
  3344. "data": {
  3345. "type": "object",
  3346. "additionalProperties": true
  3347. }
  3348. }
  3349. }
  3350. }
  3351. }
  3352. }
  3353. }
  3354. }
  3355. }
  3356. }
  3357. },
  3358. "/ocs/v2.php/cloud/users/{userId}/welcome": {
  3359. "post": {
  3360. "operationId": "users-resend-welcome-message",
  3361. "summary": "Resend the welcome message",
  3362. "tags": [
  3363. "users"
  3364. ],
  3365. "security": [
  3366. {
  3367. "bearer_auth": []
  3368. },
  3369. {
  3370. "basic_auth": []
  3371. }
  3372. ],
  3373. "parameters": [
  3374. {
  3375. "name": "userId",
  3376. "in": "path",
  3377. "description": "ID if the user",
  3378. "required": true,
  3379. "schema": {
  3380. "type": "string"
  3381. }
  3382. },
  3383. {
  3384. "name": "OCS-APIRequest",
  3385. "in": "header",
  3386. "required": true,
  3387. "schema": {
  3388. "type": "string",
  3389. "default": "true"
  3390. }
  3391. }
  3392. ],
  3393. "responses": {
  3394. "200": {
  3395. "description": "",
  3396. "content": {
  3397. "application/json": {
  3398. "schema": {
  3399. "type": "object",
  3400. "required": [
  3401. "ocs"
  3402. ],
  3403. "properties": {
  3404. "ocs": {
  3405. "type": "object",
  3406. "required": [
  3407. "meta",
  3408. "data"
  3409. ],
  3410. "properties": {
  3411. "meta": {
  3412. "$ref": "#/components/schemas/OCSMeta"
  3413. },
  3414. "data": {
  3415. "type": "object",
  3416. "additionalProperties": true
  3417. }
  3418. }
  3419. }
  3420. }
  3421. }
  3422. }
  3423. }
  3424. }
  3425. }
  3426. }
  3427. },
  3428. "/ocs/v2.php/apps/provisioning_api/api/v1/config/apps": {
  3429. "get": {
  3430. "operationId": "app_config-get-apps",
  3431. "summary": "Get a list of apps",
  3432. "description": "This endpoint requires admin access",
  3433. "tags": [
  3434. "app_config"
  3435. ],
  3436. "security": [
  3437. {
  3438. "bearer_auth": []
  3439. },
  3440. {
  3441. "basic_auth": []
  3442. }
  3443. ],
  3444. "parameters": [
  3445. {
  3446. "name": "OCS-APIRequest",
  3447. "in": "header",
  3448. "required": true,
  3449. "schema": {
  3450. "type": "string",
  3451. "default": "true"
  3452. }
  3453. }
  3454. ],
  3455. "responses": {
  3456. "200": {
  3457. "description": "",
  3458. "content": {
  3459. "application/json": {
  3460. "schema": {
  3461. "type": "object",
  3462. "required": [
  3463. "ocs"
  3464. ],
  3465. "properties": {
  3466. "ocs": {
  3467. "type": "object",
  3468. "required": [
  3469. "meta",
  3470. "data"
  3471. ],
  3472. "properties": {
  3473. "meta": {
  3474. "$ref": "#/components/schemas/OCSMeta"
  3475. },
  3476. "data": {
  3477. "type": "object",
  3478. "required": [
  3479. "data"
  3480. ],
  3481. "properties": {
  3482. "data": {
  3483. "type": "array",
  3484. "items": {
  3485. "type": "string"
  3486. }
  3487. }
  3488. }
  3489. }
  3490. }
  3491. }
  3492. }
  3493. }
  3494. }
  3495. }
  3496. }
  3497. }
  3498. }
  3499. },
  3500. "/ocs/v2.php/apps/provisioning_api/api/v1/config/apps/{app}": {
  3501. "get": {
  3502. "operationId": "app_config-get-keys",
  3503. "summary": "Get the config keys of an app",
  3504. "description": "This endpoint requires admin access",
  3505. "tags": [
  3506. "app_config"
  3507. ],
  3508. "security": [
  3509. {
  3510. "bearer_auth": []
  3511. },
  3512. {
  3513. "basic_auth": []
  3514. }
  3515. ],
  3516. "parameters": [
  3517. {
  3518. "name": "app",
  3519. "in": "path",
  3520. "description": "ID of the app",
  3521. "required": true,
  3522. "schema": {
  3523. "type": "string"
  3524. }
  3525. },
  3526. {
  3527. "name": "OCS-APIRequest",
  3528. "in": "header",
  3529. "required": true,
  3530. "schema": {
  3531. "type": "string",
  3532. "default": "true"
  3533. }
  3534. }
  3535. ],
  3536. "responses": {
  3537. "200": {
  3538. "description": "Keys returned",
  3539. "content": {
  3540. "application/json": {
  3541. "schema": {
  3542. "type": "object",
  3543. "required": [
  3544. "ocs"
  3545. ],
  3546. "properties": {
  3547. "ocs": {
  3548. "type": "object",
  3549. "required": [
  3550. "meta",
  3551. "data"
  3552. ],
  3553. "properties": {
  3554. "meta": {
  3555. "$ref": "#/components/schemas/OCSMeta"
  3556. },
  3557. "data": {
  3558. "type": "object",
  3559. "required": [
  3560. "data"
  3561. ],
  3562. "properties": {
  3563. "data": {
  3564. "type": "array",
  3565. "items": {
  3566. "type": "string"
  3567. }
  3568. }
  3569. }
  3570. }
  3571. }
  3572. }
  3573. }
  3574. }
  3575. }
  3576. }
  3577. },
  3578. "403": {
  3579. "description": "App not allowed",
  3580. "content": {
  3581. "application/json": {
  3582. "schema": {
  3583. "type": "object",
  3584. "required": [
  3585. "ocs"
  3586. ],
  3587. "properties": {
  3588. "ocs": {
  3589. "type": "object",
  3590. "required": [
  3591. "meta",
  3592. "data"
  3593. ],
  3594. "properties": {
  3595. "meta": {
  3596. "$ref": "#/components/schemas/OCSMeta"
  3597. },
  3598. "data": {
  3599. "type": "object",
  3600. "required": [
  3601. "data"
  3602. ],
  3603. "properties": {
  3604. "data": {
  3605. "type": "object",
  3606. "required": [
  3607. "message"
  3608. ],
  3609. "properties": {
  3610. "message": {
  3611. "type": "string"
  3612. }
  3613. }
  3614. }
  3615. }
  3616. }
  3617. }
  3618. }
  3619. }
  3620. }
  3621. }
  3622. }
  3623. }
  3624. }
  3625. }
  3626. },
  3627. "/ocs/v2.php/apps/provisioning_api/api/v1/config/apps/{app}/{key}": {
  3628. "get": {
  3629. "operationId": "app_config-get-value",
  3630. "summary": "Get a the config value of an app",
  3631. "description": "This endpoint requires admin access",
  3632. "tags": [
  3633. "app_config"
  3634. ],
  3635. "security": [
  3636. {
  3637. "bearer_auth": []
  3638. },
  3639. {
  3640. "basic_auth": []
  3641. }
  3642. ],
  3643. "parameters": [
  3644. {
  3645. "name": "defaultValue",
  3646. "in": "query",
  3647. "description": "Default returned value if the value is empty",
  3648. "schema": {
  3649. "type": "string",
  3650. "default": ""
  3651. }
  3652. },
  3653. {
  3654. "name": "app",
  3655. "in": "path",
  3656. "description": "ID if the app",
  3657. "required": true,
  3658. "schema": {
  3659. "type": "string"
  3660. }
  3661. },
  3662. {
  3663. "name": "key",
  3664. "in": "path",
  3665. "description": "Key",
  3666. "required": true,
  3667. "schema": {
  3668. "type": "string"
  3669. }
  3670. },
  3671. {
  3672. "name": "OCS-APIRequest",
  3673. "in": "header",
  3674. "required": true,
  3675. "schema": {
  3676. "type": "string",
  3677. "default": "true"
  3678. }
  3679. }
  3680. ],
  3681. "responses": {
  3682. "200": {
  3683. "description": "Value returned",
  3684. "content": {
  3685. "application/json": {
  3686. "schema": {
  3687. "type": "object",
  3688. "required": [
  3689. "ocs"
  3690. ],
  3691. "properties": {
  3692. "ocs": {
  3693. "type": "object",
  3694. "required": [
  3695. "meta",
  3696. "data"
  3697. ],
  3698. "properties": {
  3699. "meta": {
  3700. "$ref": "#/components/schemas/OCSMeta"
  3701. },
  3702. "data": {
  3703. "type": "object",
  3704. "required": [
  3705. "data"
  3706. ],
  3707. "properties": {
  3708. "data": {
  3709. "type": "string"
  3710. }
  3711. }
  3712. }
  3713. }
  3714. }
  3715. }
  3716. }
  3717. }
  3718. }
  3719. },
  3720. "403": {
  3721. "description": "App not allowed",
  3722. "content": {
  3723. "application/json": {
  3724. "schema": {
  3725. "type": "object",
  3726. "required": [
  3727. "ocs"
  3728. ],
  3729. "properties": {
  3730. "ocs": {
  3731. "type": "object",
  3732. "required": [
  3733. "meta",
  3734. "data"
  3735. ],
  3736. "properties": {
  3737. "meta": {
  3738. "$ref": "#/components/schemas/OCSMeta"
  3739. },
  3740. "data": {
  3741. "type": "object",
  3742. "required": [
  3743. "data"
  3744. ],
  3745. "properties": {
  3746. "data": {
  3747. "type": "object",
  3748. "required": [
  3749. "message"
  3750. ],
  3751. "properties": {
  3752. "message": {
  3753. "type": "string"
  3754. }
  3755. }
  3756. }
  3757. }
  3758. }
  3759. }
  3760. }
  3761. }
  3762. }
  3763. }
  3764. }
  3765. }
  3766. }
  3767. },
  3768. "post": {
  3769. "operationId": "app_config-set-value",
  3770. "summary": "Update the config value of an app",
  3771. "tags": [
  3772. "app_config"
  3773. ],
  3774. "security": [
  3775. {
  3776. "bearer_auth": []
  3777. },
  3778. {
  3779. "basic_auth": []
  3780. }
  3781. ],
  3782. "parameters": [
  3783. {
  3784. "name": "value",
  3785. "in": "query",
  3786. "description": "New value for the key",
  3787. "required": true,
  3788. "schema": {
  3789. "type": "string"
  3790. }
  3791. },
  3792. {
  3793. "name": "app",
  3794. "in": "path",
  3795. "description": "ID of the app",
  3796. "required": true,
  3797. "schema": {
  3798. "type": "string"
  3799. }
  3800. },
  3801. {
  3802. "name": "key",
  3803. "in": "path",
  3804. "description": "Key to update",
  3805. "required": true,
  3806. "schema": {
  3807. "type": "string"
  3808. }
  3809. },
  3810. {
  3811. "name": "OCS-APIRequest",
  3812. "in": "header",
  3813. "required": true,
  3814. "schema": {
  3815. "type": "string",
  3816. "default": "true"
  3817. }
  3818. }
  3819. ],
  3820. "responses": {
  3821. "200": {
  3822. "description": "Value updated successfully",
  3823. "content": {
  3824. "application/json": {
  3825. "schema": {
  3826. "type": "object",
  3827. "required": [
  3828. "ocs"
  3829. ],
  3830. "properties": {
  3831. "ocs": {
  3832. "type": "object",
  3833. "required": [
  3834. "meta",
  3835. "data"
  3836. ],
  3837. "properties": {
  3838. "meta": {
  3839. "$ref": "#/components/schemas/OCSMeta"
  3840. },
  3841. "data": {
  3842. "type": "object",
  3843. "additionalProperties": true
  3844. }
  3845. }
  3846. }
  3847. }
  3848. }
  3849. }
  3850. }
  3851. },
  3852. "403": {
  3853. "description": "App or key not allowed",
  3854. "content": {
  3855. "application/json": {
  3856. "schema": {
  3857. "type": "object",
  3858. "required": [
  3859. "ocs"
  3860. ],
  3861. "properties": {
  3862. "ocs": {
  3863. "type": "object",
  3864. "required": [
  3865. "meta",
  3866. "data"
  3867. ],
  3868. "properties": {
  3869. "meta": {
  3870. "$ref": "#/components/schemas/OCSMeta"
  3871. },
  3872. "data": {
  3873. "type": "object",
  3874. "required": [
  3875. "data"
  3876. ],
  3877. "properties": {
  3878. "data": {
  3879. "type": "object",
  3880. "required": [
  3881. "message"
  3882. ],
  3883. "properties": {
  3884. "message": {
  3885. "type": "string"
  3886. }
  3887. }
  3888. }
  3889. }
  3890. }
  3891. }
  3892. }
  3893. }
  3894. }
  3895. }
  3896. }
  3897. }
  3898. }
  3899. },
  3900. "delete": {
  3901. "operationId": "app_config-delete-key",
  3902. "summary": "Delete a config key of an app",
  3903. "description": "This endpoint requires admin access",
  3904. "tags": [
  3905. "app_config"
  3906. ],
  3907. "security": [
  3908. {
  3909. "bearer_auth": []
  3910. },
  3911. {
  3912. "basic_auth": []
  3913. }
  3914. ],
  3915. "parameters": [
  3916. {
  3917. "name": "app",
  3918. "in": "path",
  3919. "description": "ID of the app",
  3920. "required": true,
  3921. "schema": {
  3922. "type": "string"
  3923. }
  3924. },
  3925. {
  3926. "name": "key",
  3927. "in": "path",
  3928. "description": "Key to delete",
  3929. "required": true,
  3930. "schema": {
  3931. "type": "string"
  3932. }
  3933. },
  3934. {
  3935. "name": "OCS-APIRequest",
  3936. "in": "header",
  3937. "required": true,
  3938. "schema": {
  3939. "type": "string",
  3940. "default": "true"
  3941. }
  3942. }
  3943. ],
  3944. "responses": {
  3945. "200": {
  3946. "description": "Key deleted successfully",
  3947. "content": {
  3948. "application/json": {
  3949. "schema": {
  3950. "type": "object",
  3951. "required": [
  3952. "ocs"
  3953. ],
  3954. "properties": {
  3955. "ocs": {
  3956. "type": "object",
  3957. "required": [
  3958. "meta",
  3959. "data"
  3960. ],
  3961. "properties": {
  3962. "meta": {
  3963. "$ref": "#/components/schemas/OCSMeta"
  3964. },
  3965. "data": {
  3966. "type": "object",
  3967. "additionalProperties": true
  3968. }
  3969. }
  3970. }
  3971. }
  3972. }
  3973. }
  3974. }
  3975. },
  3976. "403": {
  3977. "description": "App or key not allowed",
  3978. "content": {
  3979. "application/json": {
  3980. "schema": {
  3981. "type": "object",
  3982. "required": [
  3983. "ocs"
  3984. ],
  3985. "properties": {
  3986. "ocs": {
  3987. "type": "object",
  3988. "required": [
  3989. "meta",
  3990. "data"
  3991. ],
  3992. "properties": {
  3993. "meta": {
  3994. "$ref": "#/components/schemas/OCSMeta"
  3995. },
  3996. "data": {
  3997. "type": "object",
  3998. "required": [
  3999. "data"
  4000. ],
  4001. "properties": {
  4002. "data": {
  4003. "type": "object",
  4004. "required": [
  4005. "message"
  4006. ],
  4007. "properties": {
  4008. "message": {
  4009. "type": "string"
  4010. }
  4011. }
  4012. }
  4013. }
  4014. }
  4015. }
  4016. }
  4017. }
  4018. }
  4019. }
  4020. }
  4021. }
  4022. }
  4023. }
  4024. },
  4025. "/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}": {
  4026. "post": {
  4027. "operationId": "preferences-set-preference",
  4028. "summary": "Update a preference value of an app",
  4029. "tags": [
  4030. "preferences"
  4031. ],
  4032. "security": [
  4033. {
  4034. "bearer_auth": []
  4035. },
  4036. {
  4037. "basic_auth": []
  4038. }
  4039. ],
  4040. "parameters": [
  4041. {
  4042. "name": "configValue",
  4043. "in": "query",
  4044. "description": "New value",
  4045. "required": true,
  4046. "schema": {
  4047. "type": "string"
  4048. }
  4049. },
  4050. {
  4051. "name": "appId",
  4052. "in": "path",
  4053. "description": "ID of the app",
  4054. "required": true,
  4055. "schema": {
  4056. "type": "string"
  4057. }
  4058. },
  4059. {
  4060. "name": "configKey",
  4061. "in": "path",
  4062. "description": "Key of the preference",
  4063. "required": true,
  4064. "schema": {
  4065. "type": "string"
  4066. }
  4067. },
  4068. {
  4069. "name": "OCS-APIRequest",
  4070. "in": "header",
  4071. "required": true,
  4072. "schema": {
  4073. "type": "string",
  4074. "default": "true"
  4075. }
  4076. }
  4077. ],
  4078. "responses": {
  4079. "200": {
  4080. "description": "Preference updated successfully",
  4081. "content": {
  4082. "application/json": {
  4083. "schema": {
  4084. "type": "object",
  4085. "required": [
  4086. "ocs"
  4087. ],
  4088. "properties": {
  4089. "ocs": {
  4090. "type": "object",
  4091. "required": [
  4092. "meta",
  4093. "data"
  4094. ],
  4095. "properties": {
  4096. "meta": {
  4097. "$ref": "#/components/schemas/OCSMeta"
  4098. },
  4099. "data": {
  4100. "type": "object",
  4101. "additionalProperties": true
  4102. }
  4103. }
  4104. }
  4105. }
  4106. }
  4107. }
  4108. }
  4109. },
  4110. "400": {
  4111. "description": "Preference invalid",
  4112. "content": {
  4113. "application/json": {
  4114. "schema": {
  4115. "type": "object",
  4116. "required": [
  4117. "ocs"
  4118. ],
  4119. "properties": {
  4120. "ocs": {
  4121. "type": "object",
  4122. "required": [
  4123. "meta",
  4124. "data"
  4125. ],
  4126. "properties": {
  4127. "meta": {
  4128. "$ref": "#/components/schemas/OCSMeta"
  4129. },
  4130. "data": {
  4131. "type": "object",
  4132. "additionalProperties": true
  4133. }
  4134. }
  4135. }
  4136. }
  4137. }
  4138. }
  4139. }
  4140. }
  4141. }
  4142. },
  4143. "delete": {
  4144. "operationId": "preferences-delete-preference",
  4145. "summary": "Delete a preference for an app",
  4146. "tags": [
  4147. "preferences"
  4148. ],
  4149. "security": [
  4150. {
  4151. "bearer_auth": []
  4152. },
  4153. {
  4154. "basic_auth": []
  4155. }
  4156. ],
  4157. "parameters": [
  4158. {
  4159. "name": "appId",
  4160. "in": "path",
  4161. "description": "ID of the app",
  4162. "required": true,
  4163. "schema": {
  4164. "type": "string"
  4165. }
  4166. },
  4167. {
  4168. "name": "configKey",
  4169. "in": "path",
  4170. "description": "Key to delete",
  4171. "required": true,
  4172. "schema": {
  4173. "type": "string"
  4174. }
  4175. },
  4176. {
  4177. "name": "OCS-APIRequest",
  4178. "in": "header",
  4179. "required": true,
  4180. "schema": {
  4181. "type": "string",
  4182. "default": "true"
  4183. }
  4184. }
  4185. ],
  4186. "responses": {
  4187. "200": {
  4188. "description": "Preference deleted successfully",
  4189. "content": {
  4190. "application/json": {
  4191. "schema": {
  4192. "type": "object",
  4193. "required": [
  4194. "ocs"
  4195. ],
  4196. "properties": {
  4197. "ocs": {
  4198. "type": "object",
  4199. "required": [
  4200. "meta",
  4201. "data"
  4202. ],
  4203. "properties": {
  4204. "meta": {
  4205. "$ref": "#/components/schemas/OCSMeta"
  4206. },
  4207. "data": {
  4208. "type": "object",
  4209. "additionalProperties": true
  4210. }
  4211. }
  4212. }
  4213. }
  4214. }
  4215. }
  4216. }
  4217. },
  4218. "400": {
  4219. "description": "Preference invalid",
  4220. "content": {
  4221. "application/json": {
  4222. "schema": {
  4223. "type": "object",
  4224. "required": [
  4225. "ocs"
  4226. ],
  4227. "properties": {
  4228. "ocs": {
  4229. "type": "object",
  4230. "required": [
  4231. "meta",
  4232. "data"
  4233. ],
  4234. "properties": {
  4235. "meta": {
  4236. "$ref": "#/components/schemas/OCSMeta"
  4237. },
  4238. "data": {
  4239. "type": "object",
  4240. "additionalProperties": true
  4241. }
  4242. }
  4243. }
  4244. }
  4245. }
  4246. }
  4247. }
  4248. }
  4249. }
  4250. }
  4251. },
  4252. "/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}": {
  4253. "post": {
  4254. "operationId": "preferences-set-multiple-preferences",
  4255. "summary": "Update multiple preference values of an app",
  4256. "tags": [
  4257. "preferences"
  4258. ],
  4259. "security": [
  4260. {
  4261. "bearer_auth": []
  4262. },
  4263. {
  4264. "basic_auth": []
  4265. }
  4266. ],
  4267. "parameters": [
  4268. {
  4269. "name": "configs",
  4270. "in": "query",
  4271. "description": "Key-value pairs of the preferences",
  4272. "required": true,
  4273. "schema": {
  4274. "type": "string"
  4275. }
  4276. },
  4277. {
  4278. "name": "appId",
  4279. "in": "path",
  4280. "description": "ID of the app",
  4281. "required": true,
  4282. "schema": {
  4283. "type": "string"
  4284. }
  4285. },
  4286. {
  4287. "name": "OCS-APIRequest",
  4288. "in": "header",
  4289. "required": true,
  4290. "schema": {
  4291. "type": "string",
  4292. "default": "true"
  4293. }
  4294. }
  4295. ],
  4296. "responses": {
  4297. "200": {
  4298. "description": "Preferences updated successfully",
  4299. "content": {
  4300. "application/json": {
  4301. "schema": {
  4302. "type": "object",
  4303. "required": [
  4304. "ocs"
  4305. ],
  4306. "properties": {
  4307. "ocs": {
  4308. "type": "object",
  4309. "required": [
  4310. "meta",
  4311. "data"
  4312. ],
  4313. "properties": {
  4314. "meta": {
  4315. "$ref": "#/components/schemas/OCSMeta"
  4316. },
  4317. "data": {
  4318. "type": "object",
  4319. "additionalProperties": true
  4320. }
  4321. }
  4322. }
  4323. }
  4324. }
  4325. }
  4326. }
  4327. },
  4328. "400": {
  4329. "description": "Preference invalid",
  4330. "content": {
  4331. "application/json": {
  4332. "schema": {
  4333. "type": "object",
  4334. "required": [
  4335. "ocs"
  4336. ],
  4337. "properties": {
  4338. "ocs": {
  4339. "type": "object",
  4340. "required": [
  4341. "meta",
  4342. "data"
  4343. ],
  4344. "properties": {
  4345. "meta": {
  4346. "$ref": "#/components/schemas/OCSMeta"
  4347. },
  4348. "data": {
  4349. "type": "object",
  4350. "additionalProperties": true
  4351. }
  4352. }
  4353. }
  4354. }
  4355. }
  4356. }
  4357. }
  4358. }
  4359. }
  4360. },
  4361. "delete": {
  4362. "operationId": "preferences-delete-multiple-preference",
  4363. "summary": "Delete multiple preferences for an app",
  4364. "tags": [
  4365. "preferences"
  4366. ],
  4367. "security": [
  4368. {
  4369. "bearer_auth": []
  4370. },
  4371. {
  4372. "basic_auth": []
  4373. }
  4374. ],
  4375. "parameters": [
  4376. {
  4377. "name": "configKeys",
  4378. "in": "query",
  4379. "description": "Keys to delete",
  4380. "required": true,
  4381. "schema": {
  4382. "type": "string"
  4383. }
  4384. },
  4385. {
  4386. "name": "appId",
  4387. "in": "path",
  4388. "description": "ID of the app",
  4389. "required": true,
  4390. "schema": {
  4391. "type": "string"
  4392. }
  4393. },
  4394. {
  4395. "name": "OCS-APIRequest",
  4396. "in": "header",
  4397. "required": true,
  4398. "schema": {
  4399. "type": "string",
  4400. "default": "true"
  4401. }
  4402. }
  4403. ],
  4404. "responses": {
  4405. "200": {
  4406. "description": "Preferences deleted successfully",
  4407. "content": {
  4408. "application/json": {
  4409. "schema": {
  4410. "type": "object",
  4411. "required": [
  4412. "ocs"
  4413. ],
  4414. "properties": {
  4415. "ocs": {
  4416. "type": "object",
  4417. "required": [
  4418. "meta",
  4419. "data"
  4420. ],
  4421. "properties": {
  4422. "meta": {
  4423. "$ref": "#/components/schemas/OCSMeta"
  4424. },
  4425. "data": {
  4426. "type": "object",
  4427. "additionalProperties": true
  4428. }
  4429. }
  4430. }
  4431. }
  4432. }
  4433. }
  4434. }
  4435. },
  4436. "400": {
  4437. "description": "Preference invalid",
  4438. "content": {
  4439. "application/json": {
  4440. "schema": {
  4441. "type": "object",
  4442. "required": [
  4443. "ocs"
  4444. ],
  4445. "properties": {
  4446. "ocs": {
  4447. "type": "object",
  4448. "required": [
  4449. "meta",
  4450. "data"
  4451. ],
  4452. "properties": {
  4453. "meta": {
  4454. "$ref": "#/components/schemas/OCSMeta"
  4455. },
  4456. "data": {
  4457. "type": "object",
  4458. "additionalProperties": true
  4459. }
  4460. }
  4461. }
  4462. }
  4463. }
  4464. }
  4465. }
  4466. }
  4467. }
  4468. }
  4469. }
  4470. },
  4471. "tags": []
  4472. }