openapi-full.json 158 KB

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