users.yaml 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. CurrentUser:
  2. get:
  3. operationId: getCurrentUser
  4. summary: 查询当前用户
  5. parameters:
  6. - $ref: '../components/parameters.yaml#/XRequestId'
  7. responses:
  8. '200':
  9. description: 当前用户摘要
  10. content:
  11. application/json:
  12. schema:
  13. $ref: '../components/schemas.yaml#/UserResponse'
  14. '400':
  15. $ref: '../components/responses.yaml#/InvalidArgument'
  16. '401':
  17. $ref: '../components/responses.yaml#/AuthenticationError'
  18. '403':
  19. $ref: '../components/responses.yaml#/Forbidden'
  20. '500':
  21. $ref: '../components/responses.yaml#/InternalError'
  22. CurrentUserUiTheme:
  23. put:
  24. operationId: updateCurrentUserUiTheme
  25. summary: 更新本人界面主题偏好(契约1.20)
  26. description: 账号级漫游偏好;仅本人可改,无需管理权限。纯视觉偏好,不校验rowVersion、不使Token失效、不写审计日志。
  27. parameters:
  28. - $ref: '../components/parameters.yaml#/XRequestId'
  29. requestBody:
  30. required: true
  31. content:
  32. application/json:
  33. schema:
  34. $ref: '../components/schemas.yaml#/UpdateUiThemeRequest'
  35. responses:
  36. '200':
  37. description: 更新成功,返回最新用户摘要
  38. content:
  39. application/json:
  40. schema:
  41. $ref: '../components/schemas.yaml#/UserResponse'
  42. '400':
  43. $ref: '../components/responses.yaml#/InvalidArgument'
  44. '401':
  45. $ref: '../components/responses.yaml#/AuthenticationError'
  46. '500':
  47. $ref: '../components/responses.yaml#/InternalError'
  48. Users:
  49. get:
  50. operationId: listUsers
  51. summary: 分页查询人员
  52. parameters:
  53. - $ref: '../components/parameters.yaml#/XRequestId'
  54. - name: organizationId
  55. in: query
  56. schema:
  57. $ref: '../components/schemas.yaml#/StringId'
  58. - name: includeDescendants
  59. in: query
  60. schema:
  61. type: boolean
  62. default: false
  63. - name: keyword
  64. in: query
  65. schema:
  66. type: string
  67. - name: status
  68. in: query
  69. schema:
  70. $ref: '../components/schemas.yaml#/EnabledStatus'
  71. - name: page
  72. in: query
  73. schema:
  74. type: integer
  75. minimum: 1
  76. default: 1
  77. - name: pageSize
  78. in: query
  79. schema:
  80. type: integer
  81. minimum: 1
  82. maximum: 100
  83. default: 20
  84. responses:
  85. '200':
  86. description: 人员分页结果
  87. content:
  88. application/json:
  89. schema:
  90. $ref: '../components/schemas.yaml#/UserPageResponse'
  91. '400':
  92. $ref: '../components/responses.yaml#/InvalidArgument'
  93. '401':
  94. $ref: '../components/responses.yaml#/AuthenticationError'
  95. '403':
  96. $ref: '../components/responses.yaml#/Forbidden'
  97. '500':
  98. $ref: '../components/responses.yaml#/InternalError'
  99. post:
  100. operationId: createUser
  101. summary: 创建用户
  102. parameters:
  103. - $ref: '../components/parameters.yaml#/XRequestId'
  104. requestBody:
  105. required: true
  106. content:
  107. application/json:
  108. schema:
  109. $ref: '../components/schemas.yaml#/CreateUserRequest'
  110. responses:
  111. '201':
  112. description: 创建成功
  113. content:
  114. application/json:
  115. schema:
  116. $ref: '../components/schemas.yaml#/UserResponse'
  117. '400':
  118. $ref: '../components/responses.yaml#/InvalidArgument'
  119. '401':
  120. $ref: '../components/responses.yaml#/AuthenticationError'
  121. '403':
  122. $ref: '../components/responses.yaml#/Forbidden'
  123. '409':
  124. $ref: '../components/responses.yaml#/Conflict'
  125. '500':
  126. $ref: '../components/responses.yaml#/InternalError'
  127. User:
  128. parameters:
  129. - name: id
  130. in: path
  131. required: true
  132. schema:
  133. $ref: '../components/schemas.yaml#/StringId'
  134. put:
  135. operationId: updateUser
  136. summary: 编辑用户
  137. requestBody:
  138. required: true
  139. content:
  140. application/json:
  141. schema:
  142. $ref: '../components/schemas.yaml#/UpdateUserRequest'
  143. responses:
  144. '200':
  145. description: 编辑成功
  146. content:
  147. application/json:
  148. schema:
  149. $ref: '../components/schemas.yaml#/UserResponse'
  150. '400':
  151. $ref: '../components/responses.yaml#/InvalidArgument'
  152. '401':
  153. $ref: '../components/responses.yaml#/AuthenticationError'
  154. '403':
  155. $ref: '../components/responses.yaml#/Forbidden'
  156. '404':
  157. $ref: '../components/responses.yaml#/NotFound'
  158. '409':
  159. $ref: '../components/responses.yaml#/Conflict'
  160. '500':
  161. $ref: '../components/responses.yaml#/InternalError'
  162. delete:
  163. operationId: deleteUser
  164. summary: 逻辑删除用户
  165. parameters:
  166. - name: rowVersion
  167. in: query
  168. required: true
  169. schema: {type: integer, minimum: 0}
  170. responses:
  171. '200':
  172. description: 删除成功
  173. content:
  174. application/json:
  175. schema:
  176. $ref: '../components/schemas.yaml#/DeleteUserResponse'
  177. '400':
  178. $ref: '../components/responses.yaml#/InvalidArgument'
  179. '401':
  180. $ref: '../components/responses.yaml#/AuthenticationError'
  181. '403':
  182. $ref: '../components/responses.yaml#/Forbidden'
  183. '404':
  184. $ref: '../components/responses.yaml#/NotFound'
  185. '409':
  186. $ref: '../components/responses.yaml#/Conflict'
  187. '500':
  188. $ref: '../components/responses.yaml#/InternalError'
  189. UserResetPassword:
  190. parameters:
  191. - name: id
  192. in: path
  193. required: true
  194. schema:
  195. $ref: '../components/schemas.yaml#/StringId'
  196. post:
  197. operationId: resetUserPassword
  198. summary: 重置用户密码
  199. requestBody:
  200. required: true
  201. content:
  202. application/json:
  203. schema:
  204. $ref: '../components/schemas.yaml#/ResetUserPasswordRequest'
  205. responses:
  206. '200':
  207. description: 重置成功
  208. content:
  209. application/json:
  210. schema:
  211. $ref: '../components/schemas.yaml#/ResetPasswordResponse'
  212. '400':
  213. $ref: '../components/responses.yaml#/InvalidArgument'
  214. '401':
  215. $ref: '../components/responses.yaml#/AuthenticationError'
  216. '403':
  217. $ref: '../components/responses.yaml#/Forbidden'
  218. '404':
  219. $ref: '../components/responses.yaml#/NotFound'
  220. '409':
  221. $ref: '../components/responses.yaml#/Conflict'
  222. '500':
  223. $ref: '../components/responses.yaml#/InternalError'