Browse code
Merge pull request #18769 from runcom/docs-auth-1
docs: extend: authorization.md: add a note about confidential stuff in Err
Sebastiaan van Stijn authored on 2015/12/19 22:53:25Showing 1 changed files
| ... | ... |
@@ -219,7 +219,7 @@ Name | Type | Description |
| 219 | 219 |
--------|--------|---------------------------------------------------------------------------------- |
| 220 | 220 |
Allow | bool | Boolean value indicating whether the request is allowed or denied |
| 221 | 221 |
Msg | string | Authorization message (will be returned to the client in case the access is denied) |
| 222 |
-Err | string | Error message (will be returned to the client in case the plugin encounter an error) |
|
| 222 |
+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) |
|
| 223 | 223 |
|
| 224 | 224 |
### Response authorization |
| 225 | 225 |
|
| ... | ... |
@@ -247,4 +247,4 @@ Name | Type | Description |
| 247 | 247 |
--------|--------|---------------------------------------------------------------------------------- |
| 248 | 248 |
Allow | bool | Boolean value indicating whether the response is allowed or denied |
| 249 | 249 |
Msg | string | Authorization message (will be returned to the client in case the access is denied) |
| 250 |
-Err | string | Error message (will be returned to the client in case the plugin encounter an error) |
|
| 250 |
+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) |