emqx_dashboard_api.hocon 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. emqx_dashboard_api {
  2. change_pwd_api.desc:
  3. """Change dashboard user password"""
  4. change_pwd_api.label:
  5. """Change dashboard user password"""
  6. create_user_api.desc:
  7. """Create dashboard user"""
  8. create_user_api.label:
  9. """Create dashboard user"""
  10. create_user_api_success.desc:
  11. """Create dashboard user success"""
  12. create_user_api_success.label:
  13. """Create dashboard user success"""
  14. delete_user_api.desc:
  15. """Delete dashboard user"""
  16. delete_user_api.label:
  17. """Delete dashboard user"""
  18. license.desc:
  19. """EMQX License. opensource or enterprise"""
  20. list_users_api.desc:
  21. """Dashboard list users"""
  22. list_users_api.label:
  23. """Dashboard list users"""
  24. login_api.desc:
  25. """Get Dashboard Auth Token."""
  26. login_api.label:
  27. """Get Dashboard Auth Token."""
  28. login_failed401.desc:
  29. """Login failed. Bad username or password"""
  30. login_failed_response400.desc:
  31. """Login failed. Bad username or password"""
  32. login_success.desc:
  33. """Dashboard Auth Success"""
  34. logout_api.desc:
  35. """Dashboard user logout.
  36. This endpoint is only for the Dashboard, not the `API Key`.
  37. The token from the `/login` endpoint must be a bearer authorization in the headers."""
  38. logout_api.label:
  39. """Dashboard user logout"""
  40. new_pwd.desc:
  41. """New password"""
  42. old_pwd.desc:
  43. """Old password"""
  44. password.desc:
  45. """Dashboard Password"""
  46. token.desc:
  47. """Dashboard Auth Token"""
  48. update_user_api.desc:
  49. """Update dashboard user description"""
  50. update_user_api.label:
  51. """Update dashboard user description"""
  52. update_user_api200.desc:
  53. """Update dashboard user success"""
  54. user_description.desc:
  55. """Dashboard User Description"""
  56. username.desc:
  57. """Dashboard Username"""
  58. users_api404.desc:
  59. """Dashboard user not found"""
  60. version.desc:
  61. """EMQX Version"""
  62. role.desc:
  63. """User role"""
  64. backend.desc:
  65. """User account source"""
  66. }