1
0

openapi-full.json 172 KB

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