openapi.json 185 KB

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