openapi.json 129 KB

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