get.json 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. {
  2. "operationId": "getUsers",
  3. "summary": "Get all users",
  4. "tags": ["Users"],
  5. "security": [
  6. {
  7. "BearerAuth": ["users"]
  8. }
  9. ],
  10. "parameters": [
  11. {
  12. "in": "query",
  13. "name": "expand",
  14. "description": "Expansions",
  15. "schema": {
  16. "type": "string",
  17. "enum": ["permissions"]
  18. }
  19. }
  20. ],
  21. "responses": {
  22. "200": {
  23. "description": "200 response",
  24. "content": {
  25. "application/json": {
  26. "examples": {
  27. "default": {
  28. "value": [
  29. {
  30. "id": 1,
  31. "created_on": "2020-01-30T09:36:08.000Z",
  32. "modified_on": "2020-01-30T09:41:04.000Z",
  33. "is_disabled": false,
  34. "email": "[email protected]",
  35. "name": "Jamie Curnow",
  36. "nickname": "James",
  37. "avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
  38. "roles": ["admin"]
  39. }
  40. ]
  41. },
  42. "withPermissions": {
  43. "value": [
  44. {
  45. "id": 1,
  46. "created_on": "2020-01-30T09:36:08.000Z",
  47. "modified_on": "2020-01-30T09:41:04.000Z",
  48. "is_disabled": false,
  49. "email": "[email protected]",
  50. "name": "Jamie Curnow",
  51. "nickname": "James",
  52. "avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
  53. "roles": ["admin"],
  54. "permissions": {
  55. "visibility": "all",
  56. "proxy_hosts": "manage",
  57. "redirection_hosts": "manage",
  58. "dead_hosts": "manage",
  59. "streams": "manage",
  60. "access_lists": "manage",
  61. "certificates": "manage"
  62. }
  63. }
  64. ]
  65. }
  66. },
  67. "schema": {
  68. "$ref": "../../components/user-list.json"
  69. }
  70. }
  71. }
  72. }
  73. }
  74. }