1
0

openapi-full.json 163 KB

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