authentication: document that info has to return external id

* closes inveniosoftware/invenio-app-rdm#2186
kpsherva · Jun 10, 2024 · 8cee2dc · 8cee2dc
1 parent 4f74bb9
commit 8cee2dc
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/customize/authentication.md b/docs/customize/authentication.md
@@ -577,6 +577,10 @@ handlers = _keycloak_helper.get_handlers()
 handlers["signup_handler"]["info_serializer"] = custom_info_serializer
 ```
 
+!!! info "Mandatory external id"
+    When customizing an info endpoint, it is mandatory for a field to provide an external ID. This field must be named `external_id`.
+
+
 ### New OAuth plugins
 
 If you need to implement your own OAuth plugin to enable integration with your OAuth provider,