emqx_gateway_api_authn.hocon 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. emqx_gateway_api_authn {
  2. add_authn.desc:
  3. """Enables the authenticator for client authentication for the specified gateway. <br/>
  4. When the authenticator is not configured or turned off, all client connections are assumed to be allowed. <br/>
  5. Note: Only one authenticator is allowed to be enabled at a time in the gateway, rather than allowing multiple authenticators to be configured to form an authentication chain as in MQTT."""
  6. add_user.desc:
  7. """Add user for the authenticator (only supports built_in_database)."""
  8. delete_authn.desc:
  9. """Delete the authenticator of the specified gateway."""
  10. delete_user.desc:
  11. """Delete the user for the gateway authenticator (only supports built_in_database)"""
  12. get_authn.desc:
  13. """Gets the configuration of the specified gateway authenticator.<br/>
  14. Returns 404 when gateway or authentication is not enabled."""
  15. get_user.desc:
  16. """Get user info from the gateway authenticator (only supports built_in_database)"""
  17. import_users.desc:
  18. """Import users into the gateway authenticator (only supports built_in_database)"""
  19. is_superuser.desc:
  20. """Is superuser"""
  21. like_user_id.desc:
  22. """Fuzzy search using user ID (username or clientid), only supports search by substring."""
  23. list_users.desc:
  24. """Get the users for the authenticator (only supported by <code>built_in_database</code>)."""
  25. update_authn.desc:
  26. """Update the configuration of the specified gateway authenticator, or disable the authenticator."""
  27. update_user.desc:
  28. """Update the user info for the gateway authenticator (only supports built_in_database)"""
  29. user_id.desc:
  30. """User ID"""
  31. }