Преглед изворни кода

chore(jwt): clearer explanation for verify_claims

JianBo He пре 5 година
родитељ
комит
2c9ea3c29e
1 измењених фајлова са 9 додато и 5 уклоњено
  1. 9 5
      apps/emqx_auth_jwt/etc/emqx_auth_jwt.conf

+ 9 - 5
apps/emqx_auth_jwt/etc/emqx_auth_jwt.conf

@@ -36,10 +36,14 @@ auth.jwt.verify_claims = off
 
 ## The checklist of claims to validate
 ##
-## Value: String
-## auth.jwt.verify_claims.$name = expected
+## Configuration format: auth.jwt.verify_claims.$name = $expected
+##   - $name: the name of the field in the JWT payload to be verified
+##   - $expected: the expected value
+##
+## The available placeholders for $expected:
+##   - %u: username
+##   - %c: clientid
 ##
-## Variables:
-##  - %u: username
-##  - %c: clientid
+## For example, to verify that the username in the JWT payload is the same
+## as the client (MQTT protocol) username
 #auth.jwt.verify_claims.username = %u