1
0

openapi.json 129 KB

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