1
0

openapi-full.json 172 KB

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