openapi-full.json 164 KB

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