You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

openapi.json 175KB

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