openapi.json 174 KB

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