1
0

openapi-full.json 175 KB

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