From ebdda1b62e5fcbccd188626d7fd8b91e4c28e50c Mon Sep 17 00:00:00 2001 From: Nicola Murino Date: Sat, 5 Aug 2023 12:12:16 +0200 Subject: [PATCH] pre-login hook doc: add a note about partial updates Signed-off-by: Nicola Murino --- docs/dynamic-user-mod.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/dynamic-user-mod.md b/docs/dynamic-user-mod.md index 860eaf4e..188daaaf 100644 --- a/docs/dynamic-user-mod.md +++ b/docs/dynamic-user-mod.md @@ -22,12 +22,14 @@ The request body will contain the user trying to login serialized as JSON. If no Actions defined for user's updates will not be executed in this case and an already logged in user with the same username will not be disconnected, you have to handle these things yourself. -The JSON response can include only the fields to update instead of the full user. For example, if you want to disable the user, you can return a response like this: +For very simple use cases, the JSON response can include only the fields to update instead of the full user. For example, if you want to disable the user, you can return a response like this: ```json {"status": 0} ``` +This will not work as expected for sub-struct and lists. + Please note that if you want to create a new user, the pre-login hook response must include all the mandatory user fields. The program hook must finish within 30 seconds, the HTTP hook will use the global configuration for HTTP clients.