openapi-full.json 170 KB

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