1
0

openapi-full.json 172 KB

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