users.yaml 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. Users:
  23. get:
  24. operationId: listUsers
  25. summary: 分页查询人员
  26. parameters:
  27. - $ref: '../components/parameters.yaml#/XRequestId'
  28. - name: organizationId
  29. in: query
  30. schema:
  31. $ref: '../components/schemas.yaml#/StringId'
  32. - name: includeDescendants
  33. in: query
  34. schema:
  35. type: boolean
  36. default: false
  37. - name: keyword
  38. in: query
  39. schema:
  40. type: string
  41. - name: status
  42. in: query
  43. schema:
  44. $ref: '../components/schemas.yaml#/EnabledStatus'
  45. - name: page
  46. in: query
  47. schema:
  48. type: integer
  49. minimum: 1
  50. default: 1
  51. - name: pageSize
  52. in: query
  53. schema:
  54. type: integer
  55. minimum: 1
  56. maximum: 100
  57. default: 20
  58. responses:
  59. '200':
  60. description: 人员分页结果
  61. content:
  62. application/json:
  63. schema:
  64. $ref: '../components/schemas.yaml#/UserPageResponse'
  65. '400':
  66. $ref: '../components/responses.yaml#/InvalidArgument'
  67. '401':
  68. $ref: '../components/responses.yaml#/AuthenticationError'
  69. '403':
  70. $ref: '../components/responses.yaml#/Forbidden'
  71. '500':
  72. $ref: '../components/responses.yaml#/InternalError'