openapi-full.json 162 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936
  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. "anyOf": [
  313. {
  314. "type": "number",
  315. "format": "double"
  316. },
  317. {
  318. "type": "integer",
  319. "format": "int64"
  320. }
  321. ]
  322. },
  323. "quota": {
  324. "anyOf": [
  325. {
  326. "type": "number",
  327. "format": "double"
  328. },
  329. {
  330. "type": "integer",
  331. "format": "int64"
  332. },
  333. {
  334. "type": "string"
  335. }
  336. ]
  337. },
  338. "relative": {
  339. "anyOf": [
  340. {
  341. "type": "number",
  342. "format": "double"
  343. },
  344. {
  345. "type": "integer",
  346. "format": "int64"
  347. }
  348. ]
  349. },
  350. "total": {
  351. "anyOf": [
  352. {
  353. "type": "number",
  354. "format": "double"
  355. },
  356. {
  357. "type": "integer",
  358. "format": "int64"
  359. }
  360. ]
  361. },
  362. "used": {
  363. "anyOf": [
  364. {
  365. "type": "number",
  366. "format": "double"
  367. },
  368. {
  369. "type": "integer",
  370. "format": "int64"
  371. }
  372. ]
  373. }
  374. }
  375. }
  376. }
  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\nThis endpoint requires password confirmation",
  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\nThis endpoint requires password confirmation",
  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\nThis endpoint requires password confirmation",
  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\nThis endpoint requires password confirmation",
  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. "description": "This endpoint requires password confirmation",
  1361. "tags": [
  1362. "app_config"
  1363. ],
  1364. "security": [
  1365. {
  1366. "bearer_auth": []
  1367. },
  1368. {
  1369. "basic_auth": []
  1370. }
  1371. ],
  1372. "parameters": [
  1373. {
  1374. "name": "value",
  1375. "in": "query",
  1376. "description": "New value for the key",
  1377. "required": true,
  1378. "schema": {
  1379. "type": "string"
  1380. }
  1381. },
  1382. {
  1383. "name": "app",
  1384. "in": "path",
  1385. "description": "ID of the app",
  1386. "required": true,
  1387. "schema": {
  1388. "type": "string"
  1389. }
  1390. },
  1391. {
  1392. "name": "key",
  1393. "in": "path",
  1394. "description": "Key to update",
  1395. "required": true,
  1396. "schema": {
  1397. "type": "string"
  1398. }
  1399. },
  1400. {
  1401. "name": "OCS-APIRequest",
  1402. "in": "header",
  1403. "description": "Required to be true for the API request to pass",
  1404. "required": true,
  1405. "schema": {
  1406. "type": "boolean",
  1407. "default": true
  1408. }
  1409. }
  1410. ],
  1411. "responses": {
  1412. "200": {
  1413. "description": "Value updated successfully",
  1414. "content": {
  1415. "application/json": {
  1416. "schema": {
  1417. "type": "object",
  1418. "required": [
  1419. "ocs"
  1420. ],
  1421. "properties": {
  1422. "ocs": {
  1423. "type": "object",
  1424. "required": [
  1425. "meta",
  1426. "data"
  1427. ],
  1428. "properties": {
  1429. "meta": {
  1430. "$ref": "#/components/schemas/OCSMeta"
  1431. },
  1432. "data": {}
  1433. }
  1434. }
  1435. }
  1436. }
  1437. }
  1438. }
  1439. },
  1440. "403": {
  1441. "description": "App or key is not allowed",
  1442. "content": {
  1443. "application/json": {
  1444. "schema": {
  1445. "type": "object",
  1446. "required": [
  1447. "ocs"
  1448. ],
  1449. "properties": {
  1450. "ocs": {
  1451. "type": "object",
  1452. "required": [
  1453. "meta",
  1454. "data"
  1455. ],
  1456. "properties": {
  1457. "meta": {
  1458. "$ref": "#/components/schemas/OCSMeta"
  1459. },
  1460. "data": {
  1461. "type": "object",
  1462. "required": [
  1463. "data"
  1464. ],
  1465. "properties": {
  1466. "data": {
  1467. "type": "object",
  1468. "required": [
  1469. "message"
  1470. ],
  1471. "properties": {
  1472. "message": {
  1473. "type": "string"
  1474. }
  1475. }
  1476. }
  1477. }
  1478. }
  1479. }
  1480. }
  1481. }
  1482. }
  1483. }
  1484. }
  1485. }
  1486. }
  1487. }
  1488. },
  1489. "/ocs/v2.php/cloud/groups/details": {
  1490. "get": {
  1491. "operationId": "groups-get-groups-details",
  1492. "summary": "Get a list of groups details",
  1493. "tags": [
  1494. "groups"
  1495. ],
  1496. "security": [
  1497. {
  1498. "bearer_auth": []
  1499. },
  1500. {
  1501. "basic_auth": []
  1502. }
  1503. ],
  1504. "parameters": [
  1505. {
  1506. "name": "search",
  1507. "in": "query",
  1508. "description": "Text to search for",
  1509. "schema": {
  1510. "type": "string",
  1511. "default": ""
  1512. }
  1513. },
  1514. {
  1515. "name": "limit",
  1516. "in": "query",
  1517. "description": "Limit the amount of groups returned",
  1518. "schema": {
  1519. "type": "integer",
  1520. "format": "int64",
  1521. "nullable": true
  1522. }
  1523. },
  1524. {
  1525. "name": "offset",
  1526. "in": "query",
  1527. "description": "Offset for searching for groups",
  1528. "schema": {
  1529. "type": "integer",
  1530. "format": "int64",
  1531. "default": 0
  1532. }
  1533. },
  1534. {
  1535. "name": "OCS-APIRequest",
  1536. "in": "header",
  1537. "description": "Required to be true for the API request to pass",
  1538. "required": true,
  1539. "schema": {
  1540. "type": "boolean",
  1541. "default": true
  1542. }
  1543. }
  1544. ],
  1545. "responses": {
  1546. "200": {
  1547. "description": "Groups details returned",
  1548. "content": {
  1549. "application/json": {
  1550. "schema": {
  1551. "type": "object",
  1552. "required": [
  1553. "ocs"
  1554. ],
  1555. "properties": {
  1556. "ocs": {
  1557. "type": "object",
  1558. "required": [
  1559. "meta",
  1560. "data"
  1561. ],
  1562. "properties": {
  1563. "meta": {
  1564. "$ref": "#/components/schemas/OCSMeta"
  1565. },
  1566. "data": {
  1567. "type": "object",
  1568. "required": [
  1569. "groups"
  1570. ],
  1571. "properties": {
  1572. "groups": {
  1573. "type": "array",
  1574. "items": {
  1575. "$ref": "#/components/schemas/GroupDetails"
  1576. }
  1577. }
  1578. }
  1579. }
  1580. }
  1581. }
  1582. }
  1583. }
  1584. }
  1585. }
  1586. }
  1587. }
  1588. }
  1589. },
  1590. "/ocs/v2.php/cloud/groups/{groupId}/users": {
  1591. "get": {
  1592. "operationId": "groups-get-group-users",
  1593. "summary": "Get a list of users in the specified group",
  1594. "tags": [
  1595. "groups"
  1596. ],
  1597. "security": [
  1598. {
  1599. "bearer_auth": []
  1600. },
  1601. {
  1602. "basic_auth": []
  1603. }
  1604. ],
  1605. "parameters": [
  1606. {
  1607. "name": "groupId",
  1608. "in": "path",
  1609. "description": "ID of the group",
  1610. "required": true,
  1611. "schema": {
  1612. "type": "string",
  1613. "pattern": "^.+$"
  1614. }
  1615. },
  1616. {
  1617. "name": "OCS-APIRequest",
  1618. "in": "header",
  1619. "description": "Required to be true for the API request to pass",
  1620. "required": true,
  1621. "schema": {
  1622. "type": "boolean",
  1623. "default": true
  1624. }
  1625. }
  1626. ],
  1627. "responses": {
  1628. "200": {
  1629. "description": "User IDs returned",
  1630. "content": {
  1631. "application/json": {
  1632. "schema": {
  1633. "type": "object",
  1634. "required": [
  1635. "ocs"
  1636. ],
  1637. "properties": {
  1638. "ocs": {
  1639. "type": "object",
  1640. "required": [
  1641. "meta",
  1642. "data"
  1643. ],
  1644. "properties": {
  1645. "meta": {
  1646. "$ref": "#/components/schemas/OCSMeta"
  1647. },
  1648. "data": {
  1649. "type": "object",
  1650. "required": [
  1651. "users"
  1652. ],
  1653. "properties": {
  1654. "users": {
  1655. "type": "array",
  1656. "items": {
  1657. "type": "string"
  1658. }
  1659. }
  1660. }
  1661. }
  1662. }
  1663. }
  1664. }
  1665. }
  1666. }
  1667. }
  1668. },
  1669. "404": {
  1670. "description": "Group not found",
  1671. "content": {
  1672. "application/json": {
  1673. "schema": {
  1674. "type": "object",
  1675. "required": [
  1676. "ocs"
  1677. ],
  1678. "properties": {
  1679. "ocs": {
  1680. "type": "object",
  1681. "required": [
  1682. "meta",
  1683. "data"
  1684. ],
  1685. "properties": {
  1686. "meta": {
  1687. "$ref": "#/components/schemas/OCSMeta"
  1688. },
  1689. "data": {}
  1690. }
  1691. }
  1692. }
  1693. }
  1694. }
  1695. }
  1696. },
  1697. "403": {
  1698. "description": "Missing permissions to get users in the group",
  1699. "content": {
  1700. "application/json": {
  1701. "schema": {
  1702. "type": "object",
  1703. "required": [
  1704. "ocs"
  1705. ],
  1706. "properties": {
  1707. "ocs": {
  1708. "type": "object",
  1709. "required": [
  1710. "meta",
  1711. "data"
  1712. ],
  1713. "properties": {
  1714. "meta": {
  1715. "$ref": "#/components/schemas/OCSMeta"
  1716. },
  1717. "data": {}
  1718. }
  1719. }
  1720. }
  1721. }
  1722. }
  1723. }
  1724. }
  1725. }
  1726. }
  1727. },
  1728. "/ocs/v2.php/cloud/groups/{groupId}/users/details": {
  1729. "get": {
  1730. "operationId": "groups-get-group-users-details",
  1731. "summary": "Get a list of users details in the specified group",
  1732. "tags": [
  1733. "groups"
  1734. ],
  1735. "security": [
  1736. {
  1737. "bearer_auth": []
  1738. },
  1739. {
  1740. "basic_auth": []
  1741. }
  1742. ],
  1743. "parameters": [
  1744. {
  1745. "name": "search",
  1746. "in": "query",
  1747. "description": "Text to search for",
  1748. "schema": {
  1749. "type": "string",
  1750. "default": ""
  1751. }
  1752. },
  1753. {
  1754. "name": "limit",
  1755. "in": "query",
  1756. "description": "Limit the amount of groups returned",
  1757. "schema": {
  1758. "type": "integer",
  1759. "format": "int64",
  1760. "nullable": true
  1761. }
  1762. },
  1763. {
  1764. "name": "offset",
  1765. "in": "query",
  1766. "description": "Offset for searching for groups",
  1767. "schema": {
  1768. "type": "integer",
  1769. "format": "int64",
  1770. "default": 0
  1771. }
  1772. },
  1773. {
  1774. "name": "groupId",
  1775. "in": "path",
  1776. "description": "ID of the group",
  1777. "required": true,
  1778. "schema": {
  1779. "type": "string",
  1780. "pattern": "^.+$"
  1781. }
  1782. },
  1783. {
  1784. "name": "OCS-APIRequest",
  1785. "in": "header",
  1786. "description": "Required to be true for the API request to pass",
  1787. "required": true,
  1788. "schema": {
  1789. "type": "boolean",
  1790. "default": true
  1791. }
  1792. }
  1793. ],
  1794. "responses": {
  1795. "200": {
  1796. "description": "Group users details returned",
  1797. "content": {
  1798. "application/json": {
  1799. "schema": {
  1800. "type": "object",
  1801. "required": [
  1802. "ocs"
  1803. ],
  1804. "properties": {
  1805. "ocs": {
  1806. "type": "object",
  1807. "required": [
  1808. "meta",
  1809. "data"
  1810. ],
  1811. "properties": {
  1812. "meta": {
  1813. "$ref": "#/components/schemas/OCSMeta"
  1814. },
  1815. "data": {
  1816. "type": "object",
  1817. "required": [
  1818. "users"
  1819. ],
  1820. "properties": {
  1821. "users": {
  1822. "type": "object",
  1823. "additionalProperties": {
  1824. "anyOf": [
  1825. {
  1826. "$ref": "#/components/schemas/UserDetails"
  1827. },
  1828. {
  1829. "type": "object",
  1830. "required": [
  1831. "id"
  1832. ],
  1833. "properties": {
  1834. "id": {
  1835. "type": "string"
  1836. }
  1837. }
  1838. }
  1839. ]
  1840. }
  1841. }
  1842. }
  1843. }
  1844. }
  1845. }
  1846. }
  1847. }
  1848. }
  1849. }
  1850. }
  1851. }
  1852. }
  1853. },
  1854. "/ocs/v2.php/cloud/users": {
  1855. "get": {
  1856. "operationId": "users-get-users",
  1857. "summary": "Get a list of users",
  1858. "tags": [
  1859. "users"
  1860. ],
  1861. "security": [
  1862. {
  1863. "bearer_auth": []
  1864. },
  1865. {
  1866. "basic_auth": []
  1867. }
  1868. ],
  1869. "parameters": [
  1870. {
  1871. "name": "search",
  1872. "in": "query",
  1873. "description": "Text to search for",
  1874. "schema": {
  1875. "type": "string",
  1876. "default": ""
  1877. }
  1878. },
  1879. {
  1880. "name": "limit",
  1881. "in": "query",
  1882. "description": "Limit the amount of groups returned",
  1883. "schema": {
  1884. "type": "integer",
  1885. "format": "int64",
  1886. "nullable": true
  1887. }
  1888. },
  1889. {
  1890. "name": "offset",
  1891. "in": "query",
  1892. "description": "Offset for searching for groups",
  1893. "schema": {
  1894. "type": "integer",
  1895. "format": "int64",
  1896. "default": 0
  1897. }
  1898. },
  1899. {
  1900. "name": "OCS-APIRequest",
  1901. "in": "header",
  1902. "description": "Required to be true for the API request to pass",
  1903. "required": true,
  1904. "schema": {
  1905. "type": "boolean",
  1906. "default": true
  1907. }
  1908. }
  1909. ],
  1910. "responses": {
  1911. "200": {
  1912. "description": "Users returned",
  1913. "content": {
  1914. "application/json": {
  1915. "schema": {
  1916. "type": "object",
  1917. "required": [
  1918. "ocs"
  1919. ],
  1920. "properties": {
  1921. "ocs": {
  1922. "type": "object",
  1923. "required": [
  1924. "meta",
  1925. "data"
  1926. ],
  1927. "properties": {
  1928. "meta": {
  1929. "$ref": "#/components/schemas/OCSMeta"
  1930. },
  1931. "data": {
  1932. "type": "object",
  1933. "required": [
  1934. "users"
  1935. ],
  1936. "properties": {
  1937. "users": {
  1938. "type": "array",
  1939. "items": {
  1940. "type": "string"
  1941. }
  1942. }
  1943. }
  1944. }
  1945. }
  1946. }
  1947. }
  1948. }
  1949. }
  1950. }
  1951. }
  1952. }
  1953. },
  1954. "post": {
  1955. "operationId": "users-add-user",
  1956. "summary": "Create a new user",
  1957. "description": "This endpoint requires password confirmation",
  1958. "tags": [
  1959. "users"
  1960. ],
  1961. "security": [
  1962. {
  1963. "bearer_auth": []
  1964. },
  1965. {
  1966. "basic_auth": []
  1967. }
  1968. ],
  1969. "parameters": [
  1970. {
  1971. "name": "userid",
  1972. "in": "query",
  1973. "description": "ID of the user",
  1974. "required": true,
  1975. "schema": {
  1976. "type": "string"
  1977. }
  1978. },
  1979. {
  1980. "name": "password",
  1981. "in": "query",
  1982. "description": "Password of the user",
  1983. "schema": {
  1984. "type": "string",
  1985. "default": ""
  1986. }
  1987. },
  1988. {
  1989. "name": "displayName",
  1990. "in": "query",
  1991. "description": "Display name of the user",
  1992. "schema": {
  1993. "type": "string",
  1994. "default": ""
  1995. }
  1996. },
  1997. {
  1998. "name": "email",
  1999. "in": "query",
  2000. "description": "Email of the user",
  2001. "schema": {
  2002. "type": "string",
  2003. "default": ""
  2004. }
  2005. },
  2006. {
  2007. "name": "groups[]",
  2008. "in": "query",
  2009. "description": "Groups of the user",
  2010. "schema": {
  2011. "type": "array",
  2012. "default": [],
  2013. "items": {
  2014. "type": "string"
  2015. }
  2016. }
  2017. },
  2018. {
  2019. "name": "subadmin[]",
  2020. "in": "query",
  2021. "description": "Groups where the user is subadmin",
  2022. "schema": {
  2023. "type": "array",
  2024. "default": [],
  2025. "items": {
  2026. "type": "string"
  2027. }
  2028. }
  2029. },
  2030. {
  2031. "name": "quota",
  2032. "in": "query",
  2033. "description": "Quota of the user",
  2034. "schema": {
  2035. "type": "string",
  2036. "default": ""
  2037. }
  2038. },
  2039. {
  2040. "name": "language",
  2041. "in": "query",
  2042. "description": "Language of the user",
  2043. "schema": {
  2044. "type": "string",
  2045. "default": ""
  2046. }
  2047. },
  2048. {
  2049. "name": "manager",
  2050. "in": "query",
  2051. "description": "Manager of the user",
  2052. "schema": {
  2053. "type": "string",
  2054. "nullable": true
  2055. }
  2056. },
  2057. {
  2058. "name": "OCS-APIRequest",
  2059. "in": "header",
  2060. "description": "Required to be true for the API request to pass",
  2061. "required": true,
  2062. "schema": {
  2063. "type": "boolean",
  2064. "default": true
  2065. }
  2066. }
  2067. ],
  2068. "responses": {
  2069. "200": {
  2070. "description": "User added successfully",
  2071. "content": {
  2072. "application/json": {
  2073. "schema": {
  2074. "type": "object",
  2075. "required": [
  2076. "ocs"
  2077. ],
  2078. "properties": {
  2079. "ocs": {
  2080. "type": "object",
  2081. "required": [
  2082. "meta",
  2083. "data"
  2084. ],
  2085. "properties": {
  2086. "meta": {
  2087. "$ref": "#/components/schemas/OCSMeta"
  2088. },
  2089. "data": {
  2090. "type": "object",
  2091. "required": [
  2092. "id"
  2093. ],
  2094. "properties": {
  2095. "id": {
  2096. "type": "string"
  2097. }
  2098. }
  2099. }
  2100. }
  2101. }
  2102. }
  2103. }
  2104. }
  2105. }
  2106. },
  2107. "403": {
  2108. "description": "Missing permissions to make user subadmin",
  2109. "content": {
  2110. "application/json": {
  2111. "schema": {
  2112. "type": "object",
  2113. "required": [
  2114. "ocs"
  2115. ],
  2116. "properties": {
  2117. "ocs": {
  2118. "type": "object",
  2119. "required": [
  2120. "meta",
  2121. "data"
  2122. ],
  2123. "properties": {
  2124. "meta": {
  2125. "$ref": "#/components/schemas/OCSMeta"
  2126. },
  2127. "data": {}
  2128. }
  2129. }
  2130. }
  2131. }
  2132. }
  2133. }
  2134. }
  2135. }
  2136. }
  2137. },
  2138. "/ocs/v2.php/cloud/users/details": {
  2139. "get": {
  2140. "operationId": "users-get-users-details",
  2141. "summary": "Get a list of users and their details",
  2142. "tags": [
  2143. "users"
  2144. ],
  2145. "security": [
  2146. {
  2147. "bearer_auth": []
  2148. },
  2149. {
  2150. "basic_auth": []
  2151. }
  2152. ],
  2153. "parameters": [
  2154. {
  2155. "name": "search",
  2156. "in": "query",
  2157. "description": "Text to search for",
  2158. "schema": {
  2159. "type": "string",
  2160. "default": ""
  2161. }
  2162. },
  2163. {
  2164. "name": "limit",
  2165. "in": "query",
  2166. "description": "Limit the amount of groups returned",
  2167. "schema": {
  2168. "type": "integer",
  2169. "format": "int64",
  2170. "nullable": true
  2171. }
  2172. },
  2173. {
  2174. "name": "offset",
  2175. "in": "query",
  2176. "description": "Offset for searching for groups",
  2177. "schema": {
  2178. "type": "integer",
  2179. "format": "int64",
  2180. "default": 0
  2181. }
  2182. },
  2183. {
  2184. "name": "OCS-APIRequest",
  2185. "in": "header",
  2186. "description": "Required to be true for the API request to pass",
  2187. "required": true,
  2188. "schema": {
  2189. "type": "boolean",
  2190. "default": true
  2191. }
  2192. }
  2193. ],
  2194. "responses": {
  2195. "200": {
  2196. "description": "Users details returned",
  2197. "content": {
  2198. "application/json": {
  2199. "schema": {
  2200. "type": "object",
  2201. "required": [
  2202. "ocs"
  2203. ],
  2204. "properties": {
  2205. "ocs": {
  2206. "type": "object",
  2207. "required": [
  2208. "meta",
  2209. "data"
  2210. ],
  2211. "properties": {
  2212. "meta": {
  2213. "$ref": "#/components/schemas/OCSMeta"
  2214. },
  2215. "data": {
  2216. "type": "object",
  2217. "required": [
  2218. "users"
  2219. ],
  2220. "properties": {
  2221. "users": {
  2222. "type": "object",
  2223. "additionalProperties": {
  2224. "anyOf": [
  2225. {
  2226. "$ref": "#/components/schemas/UserDetails"
  2227. },
  2228. {
  2229. "type": "object",
  2230. "required": [
  2231. "id"
  2232. ],
  2233. "properties": {
  2234. "id": {
  2235. "type": "string"
  2236. }
  2237. }
  2238. }
  2239. ]
  2240. }
  2241. }
  2242. }
  2243. }
  2244. }
  2245. }
  2246. }
  2247. }
  2248. }
  2249. }
  2250. }
  2251. }
  2252. }
  2253. },
  2254. "/ocs/v2.php/cloud/users/disabled": {
  2255. "get": {
  2256. "operationId": "users-get-disabled-users-details",
  2257. "summary": "Get the list of disabled users and their details",
  2258. "tags": [
  2259. "users"
  2260. ],
  2261. "security": [
  2262. {
  2263. "bearer_auth": []
  2264. },
  2265. {
  2266. "basic_auth": []
  2267. }
  2268. ],
  2269. "parameters": [
  2270. {
  2271. "name": "search",
  2272. "in": "query",
  2273. "description": "Text to search for",
  2274. "schema": {
  2275. "type": "string",
  2276. "default": ""
  2277. }
  2278. },
  2279. {
  2280. "name": "limit",
  2281. "in": "query",
  2282. "description": "Limit the amount of users returned",
  2283. "schema": {
  2284. "type": "integer",
  2285. "format": "int64",
  2286. "nullable": true
  2287. }
  2288. },
  2289. {
  2290. "name": "offset",
  2291. "in": "query",
  2292. "description": "Offset",
  2293. "schema": {
  2294. "type": "integer",
  2295. "format": "int64",
  2296. "default": 0
  2297. }
  2298. },
  2299. {
  2300. "name": "OCS-APIRequest",
  2301. "in": "header",
  2302. "description": "Required to be true for the API request to pass",
  2303. "required": true,
  2304. "schema": {
  2305. "type": "boolean",
  2306. "default": true
  2307. }
  2308. }
  2309. ],
  2310. "responses": {
  2311. "200": {
  2312. "description": "Disabled users details returned",
  2313. "content": {
  2314. "application/json": {
  2315. "schema": {
  2316. "type": "object",
  2317. "required": [
  2318. "ocs"
  2319. ],
  2320. "properties": {
  2321. "ocs": {
  2322. "type": "object",
  2323. "required": [
  2324. "meta",
  2325. "data"
  2326. ],
  2327. "properties": {
  2328. "meta": {
  2329. "$ref": "#/components/schemas/OCSMeta"
  2330. },
  2331. "data": {
  2332. "type": "object",
  2333. "required": [
  2334. "users"
  2335. ],
  2336. "properties": {
  2337. "users": {
  2338. "type": "object",
  2339. "additionalProperties": {
  2340. "anyOf": [
  2341. {
  2342. "$ref": "#/components/schemas/UserDetails"
  2343. },
  2344. {
  2345. "type": "object",
  2346. "required": [
  2347. "id"
  2348. ],
  2349. "properties": {
  2350. "id": {
  2351. "type": "string"
  2352. }
  2353. }
  2354. }
  2355. ]
  2356. }
  2357. }
  2358. }
  2359. }
  2360. }
  2361. }
  2362. }
  2363. }
  2364. }
  2365. }
  2366. }
  2367. }
  2368. }
  2369. },
  2370. "/ocs/v2.php/cloud/users/search/by-phone": {
  2371. "post": {
  2372. "operationId": "users-search-by-phone-numbers",
  2373. "summary": "Search users by their phone numbers",
  2374. "tags": [
  2375. "users"
  2376. ],
  2377. "security": [
  2378. {
  2379. "bearer_auth": []
  2380. },
  2381. {
  2382. "basic_auth": []
  2383. }
  2384. ],
  2385. "parameters": [
  2386. {
  2387. "name": "location",
  2388. "in": "query",
  2389. "description": "Location of the phone number (for country code)",
  2390. "required": true,
  2391. "schema": {
  2392. "type": "string"
  2393. }
  2394. },
  2395. {
  2396. "name": "search",
  2397. "in": "query",
  2398. "description": "Phone numbers to search for",
  2399. "required": true,
  2400. "schema": {
  2401. "type": "string"
  2402. }
  2403. },
  2404. {
  2405. "name": "OCS-APIRequest",
  2406. "in": "header",
  2407. "description": "Required to be true for the API request to pass",
  2408. "required": true,
  2409. "schema": {
  2410. "type": "boolean",
  2411. "default": true
  2412. }
  2413. }
  2414. ],
  2415. "responses": {
  2416. "200": {
  2417. "description": "Users returned",
  2418. "content": {
  2419. "application/json": {
  2420. "schema": {
  2421. "type": "object",
  2422. "required": [
  2423. "ocs"
  2424. ],
  2425. "properties": {
  2426. "ocs": {
  2427. "type": "object",
  2428. "required": [
  2429. "meta",
  2430. "data"
  2431. ],
  2432. "properties": {
  2433. "meta": {
  2434. "$ref": "#/components/schemas/OCSMeta"
  2435. },
  2436. "data": {
  2437. "type": "object",
  2438. "additionalProperties": {
  2439. "type": "string"
  2440. }
  2441. }
  2442. }
  2443. }
  2444. }
  2445. }
  2446. }
  2447. }
  2448. },
  2449. "400": {
  2450. "description": "Invalid location",
  2451. "content": {
  2452. "application/json": {
  2453. "schema": {
  2454. "type": "object",
  2455. "required": [
  2456. "ocs"
  2457. ],
  2458. "properties": {
  2459. "ocs": {
  2460. "type": "object",
  2461. "required": [
  2462. "meta",
  2463. "data"
  2464. ],
  2465. "properties": {
  2466. "meta": {
  2467. "$ref": "#/components/schemas/OCSMeta"
  2468. },
  2469. "data": {}
  2470. }
  2471. }
  2472. }
  2473. }
  2474. }
  2475. }
  2476. }
  2477. }
  2478. }
  2479. },
  2480. "/ocs/v2.php/cloud/users/{userId}": {
  2481. "get": {
  2482. "operationId": "users-get-user",
  2483. "summary": "Get the details of a user",
  2484. "tags": [
  2485. "users"
  2486. ],
  2487. "security": [
  2488. {
  2489. "bearer_auth": []
  2490. },
  2491. {
  2492. "basic_auth": []
  2493. }
  2494. ],
  2495. "parameters": [
  2496. {
  2497. "name": "userId",
  2498. "in": "path",
  2499. "description": "ID of the user",
  2500. "required": true,
  2501. "schema": {
  2502. "type": "string"
  2503. }
  2504. },
  2505. {
  2506. "name": "OCS-APIRequest",
  2507. "in": "header",
  2508. "description": "Required to be true for the API request to pass",
  2509. "required": true,
  2510. "schema": {
  2511. "type": "boolean",
  2512. "default": true
  2513. }
  2514. }
  2515. ],
  2516. "responses": {
  2517. "200": {
  2518. "description": "User returned",
  2519. "content": {
  2520. "application/json": {
  2521. "schema": {
  2522. "type": "object",
  2523. "required": [
  2524. "ocs"
  2525. ],
  2526. "properties": {
  2527. "ocs": {
  2528. "type": "object",
  2529. "required": [
  2530. "meta",
  2531. "data"
  2532. ],
  2533. "properties": {
  2534. "meta": {
  2535. "$ref": "#/components/schemas/OCSMeta"
  2536. },
  2537. "data": {
  2538. "$ref": "#/components/schemas/UserDetails"
  2539. }
  2540. }
  2541. }
  2542. }
  2543. }
  2544. }
  2545. }
  2546. }
  2547. }
  2548. },
  2549. "put": {
  2550. "operationId": "users-edit-user",
  2551. "summary": "Update a value of the user's details",
  2552. "description": "This endpoint requires password confirmation",
  2553. "tags": [
  2554. "users"
  2555. ],
  2556. "security": [
  2557. {
  2558. "bearer_auth": []
  2559. },
  2560. {
  2561. "basic_auth": []
  2562. }
  2563. ],
  2564. "parameters": [
  2565. {
  2566. "name": "key",
  2567. "in": "query",
  2568. "description": "Key that will be updated",
  2569. "required": true,
  2570. "schema": {
  2571. "type": "string"
  2572. }
  2573. },
  2574. {
  2575. "name": "value",
  2576. "in": "query",
  2577. "description": "New value for the key",
  2578. "required": true,
  2579. "schema": {
  2580. "type": "string"
  2581. }
  2582. },
  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 value edited 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. "delete": {
  2635. "operationId": "users-delete-user",
  2636. "summary": "Delete a user",
  2637. "description": "This endpoint requires password confirmation",
  2638. "tags": [
  2639. "users"
  2640. ],
  2641. "security": [
  2642. {
  2643. "bearer_auth": []
  2644. },
  2645. {
  2646. "basic_auth": []
  2647. }
  2648. ],
  2649. "parameters": [
  2650. {
  2651. "name": "userId",
  2652. "in": "path",
  2653. "description": "ID of the user",
  2654. "required": true,
  2655. "schema": {
  2656. "type": "string"
  2657. }
  2658. },
  2659. {
  2660. "name": "OCS-APIRequest",
  2661. "in": "header",
  2662. "description": "Required to be true for the API request to pass",
  2663. "required": true,
  2664. "schema": {
  2665. "type": "boolean",
  2666. "default": true
  2667. }
  2668. }
  2669. ],
  2670. "responses": {
  2671. "200": {
  2672. "description": "User deleted successfully",
  2673. "content": {
  2674. "application/json": {
  2675. "schema": {
  2676. "type": "object",
  2677. "required": [
  2678. "ocs"
  2679. ],
  2680. "properties": {
  2681. "ocs": {
  2682. "type": "object",
  2683. "required": [
  2684. "meta",
  2685. "data"
  2686. ],
  2687. "properties": {
  2688. "meta": {
  2689. "$ref": "#/components/schemas/OCSMeta"
  2690. },
  2691. "data": {}
  2692. }
  2693. }
  2694. }
  2695. }
  2696. }
  2697. }
  2698. }
  2699. }
  2700. }
  2701. },
  2702. "/ocs/v2.php/cloud/user": {
  2703. "get": {
  2704. "operationId": "users-get-current-user",
  2705. "summary": "Get the details of the current user",
  2706. "tags": [
  2707. "users"
  2708. ],
  2709. "security": [
  2710. {
  2711. "bearer_auth": []
  2712. },
  2713. {
  2714. "basic_auth": []
  2715. }
  2716. ],
  2717. "parameters": [
  2718. {
  2719. "name": "OCS-APIRequest",
  2720. "in": "header",
  2721. "description": "Required to be true for the API request to pass",
  2722. "required": true,
  2723. "schema": {
  2724. "type": "boolean",
  2725. "default": true
  2726. }
  2727. }
  2728. ],
  2729. "responses": {
  2730. "200": {
  2731. "description": "Current user returned",
  2732. "content": {
  2733. "application/json": {
  2734. "schema": {
  2735. "type": "object",
  2736. "required": [
  2737. "ocs"
  2738. ],
  2739. "properties": {
  2740. "ocs": {
  2741. "type": "object",
  2742. "required": [
  2743. "meta",
  2744. "data"
  2745. ],
  2746. "properties": {
  2747. "meta": {
  2748. "$ref": "#/components/schemas/OCSMeta"
  2749. },
  2750. "data": {
  2751. "$ref": "#/components/schemas/UserDetails"
  2752. }
  2753. }
  2754. }
  2755. }
  2756. }
  2757. }
  2758. }
  2759. }
  2760. }
  2761. }
  2762. },
  2763. "/ocs/v2.php/cloud/user/fields": {
  2764. "get": {
  2765. "operationId": "users-get-editable-fields",
  2766. "summary": "Get a list of fields that are editable for the current user",
  2767. "tags": [
  2768. "users"
  2769. ],
  2770. "security": [
  2771. {
  2772. "bearer_auth": []
  2773. },
  2774. {
  2775. "basic_auth": []
  2776. }
  2777. ],
  2778. "parameters": [
  2779. {
  2780. "name": "OCS-APIRequest",
  2781. "in": "header",
  2782. "description": "Required to be true for the API request to pass",
  2783. "required": true,
  2784. "schema": {
  2785. "type": "boolean",
  2786. "default": true
  2787. }
  2788. }
  2789. ],
  2790. "responses": {
  2791. "200": {
  2792. "description": "Editable fields returned",
  2793. "content": {
  2794. "application/json": {
  2795. "schema": {
  2796. "type": "object",
  2797. "required": [
  2798. "ocs"
  2799. ],
  2800. "properties": {
  2801. "ocs": {
  2802. "type": "object",
  2803. "required": [
  2804. "meta",
  2805. "data"
  2806. ],
  2807. "properties": {
  2808. "meta": {
  2809. "$ref": "#/components/schemas/OCSMeta"
  2810. },
  2811. "data": {
  2812. "type": "array",
  2813. "items": {
  2814. "type": "string"
  2815. }
  2816. }
  2817. }
  2818. }
  2819. }
  2820. }
  2821. }
  2822. }
  2823. }
  2824. }
  2825. }
  2826. },
  2827. "/ocs/v2.php/cloud/user/fields/{userId}": {
  2828. "get": {
  2829. "operationId": "users-get-editable-fields-for-user",
  2830. "summary": "Get a list of fields that are editable for a user",
  2831. "tags": [
  2832. "users"
  2833. ],
  2834. "security": [
  2835. {
  2836. "bearer_auth": []
  2837. },
  2838. {
  2839. "basic_auth": []
  2840. }
  2841. ],
  2842. "parameters": [
  2843. {
  2844. "name": "userId",
  2845. "in": "path",
  2846. "description": "ID of the user",
  2847. "required": true,
  2848. "schema": {
  2849. "type": "string"
  2850. }
  2851. },
  2852. {
  2853. "name": "OCS-APIRequest",
  2854. "in": "header",
  2855. "description": "Required to be true for the API request to pass",
  2856. "required": true,
  2857. "schema": {
  2858. "type": "boolean",
  2859. "default": true
  2860. }
  2861. }
  2862. ],
  2863. "responses": {
  2864. "200": {
  2865. "description": "Editable fields for user returned",
  2866. "content": {
  2867. "application/json": {
  2868. "schema": {
  2869. "type": "object",
  2870. "required": [
  2871. "ocs"
  2872. ],
  2873. "properties": {
  2874. "ocs": {
  2875. "type": "object",
  2876. "required": [
  2877. "meta",
  2878. "data"
  2879. ],
  2880. "properties": {
  2881. "meta": {
  2882. "$ref": "#/components/schemas/OCSMeta"
  2883. },
  2884. "data": {
  2885. "type": "array",
  2886. "items": {
  2887. "type": "string"
  2888. }
  2889. }
  2890. }
  2891. }
  2892. }
  2893. }
  2894. }
  2895. }
  2896. }
  2897. }
  2898. }
  2899. },
  2900. "/ocs/v2.php/cloud/users/{userId}/{collectionName}": {
  2901. "put": {
  2902. "operationId": "users-edit-user-multi-value",
  2903. "summary": "Update multiple values of the user's details",
  2904. "description": "This endpoint requires password confirmation",
  2905. "tags": [
  2906. "users"
  2907. ],
  2908. "security": [
  2909. {
  2910. "bearer_auth": []
  2911. },
  2912. {
  2913. "basic_auth": []
  2914. }
  2915. ],
  2916. "parameters": [
  2917. {
  2918. "name": "key",
  2919. "in": "query",
  2920. "description": "Key that will be updated",
  2921. "required": true,
  2922. "schema": {
  2923. "type": "string"
  2924. }
  2925. },
  2926. {
  2927. "name": "value",
  2928. "in": "query",
  2929. "description": "New value for the key",
  2930. "required": true,
  2931. "schema": {
  2932. "type": "string"
  2933. }
  2934. },
  2935. {
  2936. "name": "userId",
  2937. "in": "path",
  2938. "description": "ID of the user",
  2939. "required": true,
  2940. "schema": {
  2941. "type": "string"
  2942. }
  2943. },
  2944. {
  2945. "name": "collectionName",
  2946. "in": "path",
  2947. "description": "Collection to update",
  2948. "required": true,
  2949. "schema": {
  2950. "type": "string",
  2951. "pattern": "^(?!enable$|disable$)[a-zA-Z0-9_]*$"
  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": "User values edited 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}/wipe": {
  2998. "post": {
  2999. "operationId": "users-wipe-user-devices",
  3000. "summary": "Wipe all devices of a user",
  3001. "description": "This endpoint requires password confirmation",
  3002. "tags": [
  3003. "users"
  3004. ],
  3005. "security": [
  3006. {
  3007. "bearer_auth": []
  3008. },
  3009. {
  3010. "basic_auth": []
  3011. }
  3012. ],
  3013. "parameters": [
  3014. {
  3015. "name": "userId",
  3016. "in": "path",
  3017. "description": "ID of the user",
  3018. "required": true,
  3019. "schema": {
  3020. "type": "string"
  3021. }
  3022. },
  3023. {
  3024. "name": "OCS-APIRequest",
  3025. "in": "header",
  3026. "description": "Required to be true for the API request to pass",
  3027. "required": true,
  3028. "schema": {
  3029. "type": "boolean",
  3030. "default": true
  3031. }
  3032. }
  3033. ],
  3034. "responses": {
  3035. "200": {
  3036. "description": "Wiped all user devices successfully",
  3037. "content": {
  3038. "application/json": {
  3039. "schema": {
  3040. "type": "object",
  3041. "required": [
  3042. "ocs"
  3043. ],
  3044. "properties": {
  3045. "ocs": {
  3046. "type": "object",
  3047. "required": [
  3048. "meta",
  3049. "data"
  3050. ],
  3051. "properties": {
  3052. "meta": {
  3053. "$ref": "#/components/schemas/OCSMeta"
  3054. },
  3055. "data": {}
  3056. }
  3057. }
  3058. }
  3059. }
  3060. }
  3061. }
  3062. }
  3063. }
  3064. }
  3065. },
  3066. "/ocs/v2.php/cloud/users/{userId}/enable": {
  3067. "put": {
  3068. "operationId": "users-enable-user",
  3069. "summary": "Enable a user",
  3070. "description": "This endpoint requires password confirmation",
  3071. "tags": [
  3072. "users"
  3073. ],
  3074. "security": [
  3075. {
  3076. "bearer_auth": []
  3077. },
  3078. {
  3079. "basic_auth": []
  3080. }
  3081. ],
  3082. "parameters": [
  3083. {
  3084. "name": "userId",
  3085. "in": "path",
  3086. "description": "ID of the user",
  3087. "required": true,
  3088. "schema": {
  3089. "type": "string"
  3090. }
  3091. },
  3092. {
  3093. "name": "OCS-APIRequest",
  3094. "in": "header",
  3095. "description": "Required to be true for the API request to pass",
  3096. "required": true,
  3097. "schema": {
  3098. "type": "boolean",
  3099. "default": true
  3100. }
  3101. }
  3102. ],
  3103. "responses": {
  3104. "200": {
  3105. "description": "User enabled successfully",
  3106. "content": {
  3107. "application/json": {
  3108. "schema": {
  3109. "type": "object",
  3110. "required": [
  3111. "ocs"
  3112. ],
  3113. "properties": {
  3114. "ocs": {
  3115. "type": "object",
  3116. "required": [
  3117. "meta",
  3118. "data"
  3119. ],
  3120. "properties": {
  3121. "meta": {
  3122. "$ref": "#/components/schemas/OCSMeta"
  3123. },
  3124. "data": {}
  3125. }
  3126. }
  3127. }
  3128. }
  3129. }
  3130. }
  3131. }
  3132. }
  3133. }
  3134. },
  3135. "/ocs/v2.php/cloud/users/{userId}/disable": {
  3136. "put": {
  3137. "operationId": "users-disable-user",
  3138. "summary": "Disable a user",
  3139. "description": "This endpoint requires password confirmation",
  3140. "tags": [
  3141. "users"
  3142. ],
  3143. "security": [
  3144. {
  3145. "bearer_auth": []
  3146. },
  3147. {
  3148. "basic_auth": []
  3149. }
  3150. ],
  3151. "parameters": [
  3152. {
  3153. "name": "userId",
  3154. "in": "path",
  3155. "description": "ID of the user",
  3156. "required": true,
  3157. "schema": {
  3158. "type": "string"
  3159. }
  3160. },
  3161. {
  3162. "name": "OCS-APIRequest",
  3163. "in": "header",
  3164. "description": "Required to be true for the API request to pass",
  3165. "required": true,
  3166. "schema": {
  3167. "type": "boolean",
  3168. "default": true
  3169. }
  3170. }
  3171. ],
  3172. "responses": {
  3173. "200": {
  3174. "description": "User disabled successfully",
  3175. "content": {
  3176. "application/json": {
  3177. "schema": {
  3178. "type": "object",
  3179. "required": [
  3180. "ocs"
  3181. ],
  3182. "properties": {
  3183. "ocs": {
  3184. "type": "object",
  3185. "required": [
  3186. "meta",
  3187. "data"
  3188. ],
  3189. "properties": {
  3190. "meta": {
  3191. "$ref": "#/components/schemas/OCSMeta"
  3192. },
  3193. "data": {}
  3194. }
  3195. }
  3196. }
  3197. }
  3198. }
  3199. }
  3200. }
  3201. }
  3202. }
  3203. },
  3204. "/ocs/v2.php/cloud/users/{userId}/groups": {
  3205. "get": {
  3206. "operationId": "users-get-users-groups",
  3207. "summary": "Get a list of groups the user belongs to",
  3208. "tags": [
  3209. "users"
  3210. ],
  3211. "security": [
  3212. {
  3213. "bearer_auth": []
  3214. },
  3215. {
  3216. "basic_auth": []
  3217. }
  3218. ],
  3219. "parameters": [
  3220. {
  3221. "name": "userId",
  3222. "in": "path",
  3223. "description": "ID of the user",
  3224. "required": true,
  3225. "schema": {
  3226. "type": "string"
  3227. }
  3228. },
  3229. {
  3230. "name": "OCS-APIRequest",
  3231. "in": "header",
  3232. "description": "Required to be true for the API request to pass",
  3233. "required": true,
  3234. "schema": {
  3235. "type": "boolean",
  3236. "default": true
  3237. }
  3238. }
  3239. ],
  3240. "responses": {
  3241. "200": {
  3242. "description": "Users groups returned",
  3243. "content": {
  3244. "application/json": {
  3245. "schema": {
  3246. "type": "object",
  3247. "required": [
  3248. "ocs"
  3249. ],
  3250. "properties": {
  3251. "ocs": {
  3252. "type": "object",
  3253. "required": [
  3254. "meta",
  3255. "data"
  3256. ],
  3257. "properties": {
  3258. "meta": {
  3259. "$ref": "#/components/schemas/OCSMeta"
  3260. },
  3261. "data": {
  3262. "type": "object",
  3263. "required": [
  3264. "groups"
  3265. ],
  3266. "properties": {
  3267. "groups": {
  3268. "type": "array",
  3269. "items": {
  3270. "type": "string"
  3271. }
  3272. }
  3273. }
  3274. }
  3275. }
  3276. }
  3277. }
  3278. }
  3279. }
  3280. }
  3281. }
  3282. }
  3283. },
  3284. "post": {
  3285. "operationId": "users-add-to-group",
  3286. "summary": "Add a user to a group",
  3287. "description": "This endpoint requires password confirmation",
  3288. "tags": [
  3289. "users"
  3290. ],
  3291. "security": [
  3292. {
  3293. "bearer_auth": []
  3294. },
  3295. {
  3296. "basic_auth": []
  3297. }
  3298. ],
  3299. "parameters": [
  3300. {
  3301. "name": "groupid",
  3302. "in": "query",
  3303. "description": "ID of the group",
  3304. "schema": {
  3305. "type": "string",
  3306. "default": ""
  3307. }
  3308. },
  3309. {
  3310. "name": "userId",
  3311. "in": "path",
  3312. "description": "ID of the user",
  3313. "required": true,
  3314. "schema": {
  3315. "type": "string"
  3316. }
  3317. },
  3318. {
  3319. "name": "OCS-APIRequest",
  3320. "in": "header",
  3321. "description": "Required to be true for the API request to pass",
  3322. "required": true,
  3323. "schema": {
  3324. "type": "boolean",
  3325. "default": true
  3326. }
  3327. }
  3328. ],
  3329. "responses": {
  3330. "200": {
  3331. "description": "User added to group successfully",
  3332. "content": {
  3333. "application/json": {
  3334. "schema": {
  3335. "type": "object",
  3336. "required": [
  3337. "ocs"
  3338. ],
  3339. "properties": {
  3340. "ocs": {
  3341. "type": "object",
  3342. "required": [
  3343. "meta",
  3344. "data"
  3345. ],
  3346. "properties": {
  3347. "meta": {
  3348. "$ref": "#/components/schemas/OCSMeta"
  3349. },
  3350. "data": {}
  3351. }
  3352. }
  3353. }
  3354. }
  3355. }
  3356. }
  3357. }
  3358. }
  3359. },
  3360. "delete": {
  3361. "operationId": "users-remove-from-group",
  3362. "summary": "Remove a user from a group",
  3363. "description": "This endpoint requires password confirmation",
  3364. "tags": [
  3365. "users"
  3366. ],
  3367. "security": [
  3368. {
  3369. "bearer_auth": []
  3370. },
  3371. {
  3372. "basic_auth": []
  3373. }
  3374. ],
  3375. "parameters": [
  3376. {
  3377. "name": "groupid",
  3378. "in": "query",
  3379. "description": "ID of the group",
  3380. "required": true,
  3381. "schema": {
  3382. "type": "string"
  3383. }
  3384. },
  3385. {
  3386. "name": "userId",
  3387. "in": "path",
  3388. "description": "ID of the user",
  3389. "required": true,
  3390. "schema": {
  3391. "type": "string"
  3392. }
  3393. },
  3394. {
  3395. "name": "OCS-APIRequest",
  3396. "in": "header",
  3397. "description": "Required to be true for the API request to pass",
  3398. "required": true,
  3399. "schema": {
  3400. "type": "boolean",
  3401. "default": true
  3402. }
  3403. }
  3404. ],
  3405. "responses": {
  3406. "200": {
  3407. "description": "User removed from group successfully",
  3408. "content": {
  3409. "application/json": {
  3410. "schema": {
  3411. "type": "object",
  3412. "required": [
  3413. "ocs"
  3414. ],
  3415. "properties": {
  3416. "ocs": {
  3417. "type": "object",
  3418. "required": [
  3419. "meta",
  3420. "data"
  3421. ],
  3422. "properties": {
  3423. "meta": {
  3424. "$ref": "#/components/schemas/OCSMeta"
  3425. },
  3426. "data": {}
  3427. }
  3428. }
  3429. }
  3430. }
  3431. }
  3432. }
  3433. }
  3434. }
  3435. }
  3436. },
  3437. "/ocs/v2.php/cloud/users/{userId}/welcome": {
  3438. "post": {
  3439. "operationId": "users-resend-welcome-message",
  3440. "summary": "Resend the welcome message",
  3441. "description": "This endpoint requires password confirmation",
  3442. "tags": [
  3443. "users"
  3444. ],
  3445. "security": [
  3446. {
  3447. "bearer_auth": []
  3448. },
  3449. {
  3450. "basic_auth": []
  3451. }
  3452. ],
  3453. "parameters": [
  3454. {
  3455. "name": "userId",
  3456. "in": "path",
  3457. "description": "ID if the user",
  3458. "required": true,
  3459. "schema": {
  3460. "type": "string"
  3461. }
  3462. },
  3463. {
  3464. "name": "OCS-APIRequest",
  3465. "in": "header",
  3466. "description": "Required to be true for the API request to pass",
  3467. "required": true,
  3468. "schema": {
  3469. "type": "boolean",
  3470. "default": true
  3471. }
  3472. }
  3473. ],
  3474. "responses": {
  3475. "200": {
  3476. "description": "Resent welcome message successfully",
  3477. "content": {
  3478. "application/json": {
  3479. "schema": {
  3480. "type": "object",
  3481. "required": [
  3482. "ocs"
  3483. ],
  3484. "properties": {
  3485. "ocs": {
  3486. "type": "object",
  3487. "required": [
  3488. "meta",
  3489. "data"
  3490. ],
  3491. "properties": {
  3492. "meta": {
  3493. "$ref": "#/components/schemas/OCSMeta"
  3494. },
  3495. "data": {}
  3496. }
  3497. }
  3498. }
  3499. }
  3500. }
  3501. }
  3502. }
  3503. }
  3504. }
  3505. },
  3506. "/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}": {
  3507. "post": {
  3508. "operationId": "preferences-set-preference",
  3509. "summary": "Update a preference value of an app",
  3510. "tags": [
  3511. "preferences"
  3512. ],
  3513. "security": [
  3514. {
  3515. "bearer_auth": []
  3516. },
  3517. {
  3518. "basic_auth": []
  3519. }
  3520. ],
  3521. "parameters": [
  3522. {
  3523. "name": "configValue",
  3524. "in": "query",
  3525. "description": "New value",
  3526. "required": true,
  3527. "schema": {
  3528. "type": "string"
  3529. }
  3530. },
  3531. {
  3532. "name": "appId",
  3533. "in": "path",
  3534. "description": "ID of the app",
  3535. "required": true,
  3536. "schema": {
  3537. "type": "string"
  3538. }
  3539. },
  3540. {
  3541. "name": "configKey",
  3542. "in": "path",
  3543. "description": "Key of the preference",
  3544. "required": true,
  3545. "schema": {
  3546. "type": "string"
  3547. }
  3548. },
  3549. {
  3550. "name": "OCS-APIRequest",
  3551. "in": "header",
  3552. "description": "Required to be true for the API request to pass",
  3553. "required": true,
  3554. "schema": {
  3555. "type": "boolean",
  3556. "default": true
  3557. }
  3558. }
  3559. ],
  3560. "responses": {
  3561. "200": {
  3562. "description": "Preference updated successfully",
  3563. "content": {
  3564. "application/json": {
  3565. "schema": {
  3566. "type": "object",
  3567. "required": [
  3568. "ocs"
  3569. ],
  3570. "properties": {
  3571. "ocs": {
  3572. "type": "object",
  3573. "required": [
  3574. "meta",
  3575. "data"
  3576. ],
  3577. "properties": {
  3578. "meta": {
  3579. "$ref": "#/components/schemas/OCSMeta"
  3580. },
  3581. "data": {}
  3582. }
  3583. }
  3584. }
  3585. }
  3586. }
  3587. }
  3588. },
  3589. "400": {
  3590. "description": "Preference invalid",
  3591. "content": {
  3592. "application/json": {
  3593. "schema": {
  3594. "type": "object",
  3595. "required": [
  3596. "ocs"
  3597. ],
  3598. "properties": {
  3599. "ocs": {
  3600. "type": "object",
  3601. "required": [
  3602. "meta",
  3603. "data"
  3604. ],
  3605. "properties": {
  3606. "meta": {
  3607. "$ref": "#/components/schemas/OCSMeta"
  3608. },
  3609. "data": {}
  3610. }
  3611. }
  3612. }
  3613. }
  3614. }
  3615. }
  3616. }
  3617. }
  3618. },
  3619. "delete": {
  3620. "operationId": "preferences-delete-preference",
  3621. "summary": "Delete a preference for an app",
  3622. "tags": [
  3623. "preferences"
  3624. ],
  3625. "security": [
  3626. {
  3627. "bearer_auth": []
  3628. },
  3629. {
  3630. "basic_auth": []
  3631. }
  3632. ],
  3633. "parameters": [
  3634. {
  3635. "name": "appId",
  3636. "in": "path",
  3637. "description": "ID of the app",
  3638. "required": true,
  3639. "schema": {
  3640. "type": "string"
  3641. }
  3642. },
  3643. {
  3644. "name": "configKey",
  3645. "in": "path",
  3646. "description": "Key to delete",
  3647. "required": true,
  3648. "schema": {
  3649. "type": "string"
  3650. }
  3651. },
  3652. {
  3653. "name": "OCS-APIRequest",
  3654. "in": "header",
  3655. "description": "Required to be true for the API request to pass",
  3656. "required": true,
  3657. "schema": {
  3658. "type": "boolean",
  3659. "default": true
  3660. }
  3661. }
  3662. ],
  3663. "responses": {
  3664. "200": {
  3665. "description": "Preference deleted successfully",
  3666. "content": {
  3667. "application/json": {
  3668. "schema": {
  3669. "type": "object",
  3670. "required": [
  3671. "ocs"
  3672. ],
  3673. "properties": {
  3674. "ocs": {
  3675. "type": "object",
  3676. "required": [
  3677. "meta",
  3678. "data"
  3679. ],
  3680. "properties": {
  3681. "meta": {
  3682. "$ref": "#/components/schemas/OCSMeta"
  3683. },
  3684. "data": {}
  3685. }
  3686. }
  3687. }
  3688. }
  3689. }
  3690. }
  3691. },
  3692. "400": {
  3693. "description": "Preference invalid",
  3694. "content": {
  3695. "application/json": {
  3696. "schema": {
  3697. "type": "object",
  3698. "required": [
  3699. "ocs"
  3700. ],
  3701. "properties": {
  3702. "ocs": {
  3703. "type": "object",
  3704. "required": [
  3705. "meta",
  3706. "data"
  3707. ],
  3708. "properties": {
  3709. "meta": {
  3710. "$ref": "#/components/schemas/OCSMeta"
  3711. },
  3712. "data": {}
  3713. }
  3714. }
  3715. }
  3716. }
  3717. }
  3718. }
  3719. }
  3720. }
  3721. }
  3722. },
  3723. "/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}": {
  3724. "post": {
  3725. "operationId": "preferences-set-multiple-preferences",
  3726. "summary": "Update multiple preference values of an app",
  3727. "tags": [
  3728. "preferences"
  3729. ],
  3730. "security": [
  3731. {
  3732. "bearer_auth": []
  3733. },
  3734. {
  3735. "basic_auth": []
  3736. }
  3737. ],
  3738. "parameters": [
  3739. {
  3740. "name": "configs",
  3741. "in": "query",
  3742. "description": "Key-value pairs of the preferences",
  3743. "required": true,
  3744. "schema": {
  3745. "type": "string"
  3746. }
  3747. },
  3748. {
  3749. "name": "appId",
  3750. "in": "path",
  3751. "description": "ID of the app",
  3752. "required": true,
  3753. "schema": {
  3754. "type": "string"
  3755. }
  3756. },
  3757. {
  3758. "name": "OCS-APIRequest",
  3759. "in": "header",
  3760. "description": "Required to be true for the API request to pass",
  3761. "required": true,
  3762. "schema": {
  3763. "type": "boolean",
  3764. "default": true
  3765. }
  3766. }
  3767. ],
  3768. "responses": {
  3769. "200": {
  3770. "description": "Preferences updated successfully",
  3771. "content": {
  3772. "application/json": {
  3773. "schema": {
  3774. "type": "object",
  3775. "required": [
  3776. "ocs"
  3777. ],
  3778. "properties": {
  3779. "ocs": {
  3780. "type": "object",
  3781. "required": [
  3782. "meta",
  3783. "data"
  3784. ],
  3785. "properties": {
  3786. "meta": {
  3787. "$ref": "#/components/schemas/OCSMeta"
  3788. },
  3789. "data": {}
  3790. }
  3791. }
  3792. }
  3793. }
  3794. }
  3795. }
  3796. },
  3797. "400": {
  3798. "description": "Preference invalid",
  3799. "content": {
  3800. "application/json": {
  3801. "schema": {
  3802. "type": "object",
  3803. "required": [
  3804. "ocs"
  3805. ],
  3806. "properties": {
  3807. "ocs": {
  3808. "type": "object",
  3809. "required": [
  3810. "meta",
  3811. "data"
  3812. ],
  3813. "properties": {
  3814. "meta": {
  3815. "$ref": "#/components/schemas/OCSMeta"
  3816. },
  3817. "data": {}
  3818. }
  3819. }
  3820. }
  3821. }
  3822. }
  3823. }
  3824. }
  3825. }
  3826. },
  3827. "delete": {
  3828. "operationId": "preferences-delete-multiple-preference",
  3829. "summary": "Delete multiple preferences for an app",
  3830. "tags": [
  3831. "preferences"
  3832. ],
  3833. "security": [
  3834. {
  3835. "bearer_auth": []
  3836. },
  3837. {
  3838. "basic_auth": []
  3839. }
  3840. ],
  3841. "parameters": [
  3842. {
  3843. "name": "configKeys[]",
  3844. "in": "query",
  3845. "description": "Keys to delete",
  3846. "required": true,
  3847. "schema": {
  3848. "type": "array",
  3849. "items": {
  3850. "type": "string"
  3851. }
  3852. }
  3853. },
  3854. {
  3855. "name": "appId",
  3856. "in": "path",
  3857. "description": "ID of the app",
  3858. "required": true,
  3859. "schema": {
  3860. "type": "string"
  3861. }
  3862. },
  3863. {
  3864. "name": "OCS-APIRequest",
  3865. "in": "header",
  3866. "description": "Required to be true for the API request to pass",
  3867. "required": true,
  3868. "schema": {
  3869. "type": "boolean",
  3870. "default": true
  3871. }
  3872. }
  3873. ],
  3874. "responses": {
  3875. "200": {
  3876. "description": "Preferences deleted successfully",
  3877. "content": {
  3878. "application/json": {
  3879. "schema": {
  3880. "type": "object",
  3881. "required": [
  3882. "ocs"
  3883. ],
  3884. "properties": {
  3885. "ocs": {
  3886. "type": "object",
  3887. "required": [
  3888. "meta",
  3889. "data"
  3890. ],
  3891. "properties": {
  3892. "meta": {
  3893. "$ref": "#/components/schemas/OCSMeta"
  3894. },
  3895. "data": {}
  3896. }
  3897. }
  3898. }
  3899. }
  3900. }
  3901. }
  3902. },
  3903. "400": {
  3904. "description": "Preference invalid",
  3905. "content": {
  3906. "application/json": {
  3907. "schema": {
  3908. "type": "object",
  3909. "required": [
  3910. "ocs"
  3911. ],
  3912. "properties": {
  3913. "ocs": {
  3914. "type": "object",
  3915. "required": [
  3916. "meta",
  3917. "data"
  3918. ],
  3919. "properties": {
  3920. "meta": {
  3921. "$ref": "#/components/schemas/OCSMeta"
  3922. },
  3923. "data": {}
  3924. }
  3925. }
  3926. }
  3927. }
  3928. }
  3929. }
  3930. }
  3931. }
  3932. }
  3933. }
  3934. },
  3935. "tags": []
  3936. }