emqx_mgmt_api_key_schema.hocon 782 B

123456789101112131415161718192021
  1. emqx_mgmt_api_key_schema {
  2. api_key.desc:
  3. """API Key, can be used to request API other than the management API key and the Dashboard user management API"""
  4. api_key.label:
  5. """API Key"""
  6. bootstrap_file.desc:
  7. """The bootstrap file provides API keys for EMQX.
  8. EMQX will load these keys on startup to authorize API requests.
  9. It contains colon-separated values in the format: `api_key:api_secret:role`.
  10. Each line specifies an API key and its associated secret, and the role of this key.
  11. The 'role' part should be the pre-defined access scope group name,
  12. for example, `administrator` or `viewer`.
  13. The 'role' is introduced in 5.4, to be backward compatible, if it is missing, the key is implicitly granted `administrator` role."""
  14. bootstrap_file.label:
  15. """Initialize api_key file."""
  16. }