emqx_authn_api.hocon 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. emqx_authn_api {
  2. authentication_get.desc:
  3. """List authenticators for global authentication."""
  4. authentication_get.label:
  5. """List authenticators"""
  6. authentication_id_delete.desc:
  7. """Delete authenticator from global authentication chain."""
  8. authentication_id_delete.label:
  9. """Delete authenticator"""
  10. authentication_id_get.desc:
  11. """Get authenticator from global authentication chain."""
  12. authentication_id_get.label:
  13. """Get authenticator"""
  14. authentication_id_position_put.desc:
  15. """Move authenticator in global authentication chain."""
  16. authentication_id_position_put.label:
  17. """Move authenticator"""
  18. authentication_id_put.desc:
  19. """Update authenticator from global authentication chain."""
  20. authentication_id_put.label:
  21. """Update authenticator"""
  22. authentication_id_status_get.desc:
  23. """Get authenticator status from global authentication chain."""
  24. authentication_id_status_get.label:
  25. """Get authenticator status"""
  26. authentication_id_users_get.desc:
  27. """List users in authenticator in global authentication chain."""
  28. authentication_id_users_get.label:
  29. """List users in authenticator"""
  30. authentication_id_users_post.desc:
  31. """Create users for authenticator in global authentication chain."""
  32. authentication_id_users_post.label:
  33. """Create users for authenticator"""
  34. authentication_id_users_user_id_delete.desc:
  35. """Delete user in authenticator in global authentication chain."""
  36. authentication_id_users_user_id_delete.label:
  37. """Delete user in authenticator"""
  38. authentication_id_users_user_id_get.desc:
  39. """Get user from authenticator in global authentication chain."""
  40. authentication_id_users_user_id_get.label:
  41. """Get user from authenticator"""
  42. authentication_id_users_user_id_put.desc:
  43. """Update user in authenticator in global authentication chain."""
  44. authentication_id_users_user_id_put.label:
  45. """Update user in authenticator"""
  46. authentication_post.desc:
  47. """Create authenticator for global authentication."""
  48. authentication_post.label:
  49. """Create authenticator"""
  50. authentication_order_put.desc:
  51. """Reorder all authenticators in global authentication chain."""
  52. authentication_order_put.label:
  53. """Reorder Authenticators"""
  54. is_superuser.desc:
  55. """Is superuser"""
  56. is_superuser.label:
  57. """Is superuser"""
  58. like_user_id.desc:
  59. """Fuzzy search user_id (username or clientid)."""
  60. like_user_id.label:
  61. """like_user_id"""
  62. listeners_listener_id_authentication_get.desc:
  63. """List authenticators for listener authentication."""
  64. listeners_listener_id_authentication_get.label:
  65. """List authenticators for listener"""
  66. listeners_listener_id_authentication_id_delete.desc:
  67. """Delete authenticator from listener authentication chain."""
  68. listeners_listener_id_authentication_id_delete.label:
  69. """Delete authenticator from listener"""
  70. listeners_listener_id_authentication_id_get.desc:
  71. """Get authenticator from listener authentication chain."""
  72. listeners_listener_id_authentication_id_get.label:
  73. """Get authenticator from listener"""
  74. listeners_listener_id_authentication_id_position_put.desc:
  75. """Move authenticator in listener authentication chain."""
  76. listeners_listener_id_authentication_id_position_put.label:
  77. """Move authenticator in listener"""
  78. listeners_listener_id_authentication_id_put.desc:
  79. """Update authenticator from listener authentication chain."""
  80. listeners_listener_id_authentication_id_put.label:
  81. """Update authenticator from listener"""
  82. listeners_listener_id_authentication_id_status_get.desc:
  83. """Get authenticator status from listener authentication chain."""
  84. listeners_listener_id_authentication_id_status_get.label:
  85. """Get authenticator status from listener"""
  86. listeners_listener_id_authentication_id_users_get.desc:
  87. """List users in authenticator in listener authentication chain."""
  88. listeners_listener_id_authentication_id_users_get.label:
  89. """List users in authenticator in listener"""
  90. listeners_listener_id_authentication_id_users_post.desc:
  91. """Create users for authenticator in listener authentication chain."""
  92. listeners_listener_id_authentication_id_users_post.label:
  93. """Create users for authenticator in listener"""
  94. listeners_listener_id_authentication_id_users_user_id_delete.desc:
  95. """Delete user in authenticator in listener authentication chain."""
  96. listeners_listener_id_authentication_id_users_user_id_delete.label:
  97. """Delete user in authenticator in listener"""
  98. listeners_listener_id_authentication_id_users_user_id_get.desc:
  99. """Get user from authenticator in listener authentication chain."""
  100. listeners_listener_id_authentication_id_users_user_id_get.label:
  101. """Get user from authenticator in listener"""
  102. listeners_listener_id_authentication_id_users_user_id_put.desc:
  103. """Update user in authenticator in listener authentication chain."""
  104. listeners_listener_id_authentication_id_users_user_id_put.label:
  105. """Update user in authenticator in listener"""
  106. listeners_listener_id_authentication_post.desc:
  107. """Create authenticator for listener authentication."""
  108. listeners_listener_id_authentication_post.label:
  109. """Create authenticator for listener"""
  110. param_auth_id.desc:
  111. """Authenticator ID."""
  112. param_auth_id.label:
  113. """Authenticator ID"""
  114. param_listener_id.desc:
  115. """Listener ID."""
  116. param_listener_id.label:
  117. """Listener ID"""
  118. param_position.desc:
  119. """Position of authenticator in chain. Possible values are 'front', 'rear', 'before:{other_authenticator}', 'after:{other_authenticator}'."""
  120. param_position.label:
  121. """Position of authenticator"""
  122. param_user_id.desc:
  123. """User ID."""
  124. param_user_id.label:
  125. """User ID"""
  126. }