Browse Source

Merge pull request #18769 from runcom/docs-auth-1

docs: extend: authorization.md: add a note about confidential stuff in Err
Sebastiaan van Stijn 9 years ago
parent
commit
eaf7932faf
1 changed files with 2 additions and 2 deletions
  1. 2 2
      docs/extend/authorization.md

+ 2 - 2
docs/extend/authorization.md

@@ -219,7 +219,7 @@ Name    | Type   | Description
 --------|--------|----------------------------------------------------------------------------------
 --------|--------|----------------------------------------------------------------------------------
 Allow   | bool   | Boolean value indicating whether the request is allowed or denied
 Allow   | bool   | Boolean value indicating whether the request is allowed or denied
 Msg     | string | Authorization message (will be returned to the client in case the access is denied)
 Msg     | string | Authorization message (will be returned to the client in case the access is denied)
-Err     | string | Error message (will be returned to the client in case the plugin encounter an error)
+Err     | string | Error message (will be returned to the client in case the plugin encounter an error. The string value supplied may appear in logs, so should not include confidential information)
 
 
 ### Response authorization
 ### Response authorization
 
 
@@ -247,4 +247,4 @@ Name    | Type   | Description
 --------|--------|----------------------------------------------------------------------------------
 --------|--------|----------------------------------------------------------------------------------
 Allow   | bool   | Boolean value indicating whether the response is allowed or denied
 Allow   | bool   | Boolean value indicating whether the response is allowed or denied
 Msg     | string | Authorization message (will be returned to the client in case the access is denied)
 Msg     | string | Authorization message (will be returned to the client in case the access is denied)
-Err     | string | Error message (will be returned to the client in case the plugin encounter an error)
+Err     | string | Error message (will be returned to the client in case the plugin encounter an error. The string value supplied may appear in logs, so should not include confidential information)