emqx_authz_api_schema.hocon 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. emqx_authz_api_schema {
  2. body.desc:
  3. """HTTP request body."""
  4. body.label:
  5. """body"""
  6. cmd.desc:
  7. """Database query used to retrieve authorization data."""
  8. cmd.label:
  9. """cmd"""
  10. collection.desc:
  11. """`MongoDB` collection containing the authorization data."""
  12. collection.label:
  13. """collection"""
  14. enable.desc:
  15. """Set to <code>true</code> or <code>false</code> to disable this ACL provider."""
  16. enable.label:
  17. """enable"""
  18. filter.desc:
  19. """Conditional expression that defines the filter condition in the query.
  20. Filter supports the following placeholders:
  21. - <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting;
  22. - <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting."""
  23. filter.label:
  24. """Filter"""
  25. headers.desc:
  26. """List of HTTP Headers."""
  27. headers.label:
  28. """Headers"""
  29. headers_no_content_type.desc:
  30. """List of HTTP headers (without <code>content-type</code>)."""
  31. headers_no_content_type.label:
  32. """headers_no_content_type"""
  33. method.desc:
  34. """HTTP method."""
  35. method.label:
  36. """method"""
  37. position.desc:
  38. """Where to place the source."""
  39. position.label:
  40. """position"""
  41. query.desc:
  42. """Database query used to retrieve authorization data."""
  43. query.label:
  44. """query"""
  45. request_timeout.desc:
  46. """Request timeout."""
  47. request_timeout.label:
  48. """request_timeout"""
  49. rules.desc:
  50. """Authorization static file rules."""
  51. rules.label:
  52. """rules"""
  53. type.desc:
  54. """Backend type."""
  55. type.label:
  56. """type"""
  57. url.desc:
  58. """URL of the auth server."""
  59. url.label:
  60. """url"""
  61. }