From 4f6e15b3066031721b4b09bd8a05e9c9966d3b12 Mon Sep 17 00:00:00 2001
From: yu-i-i <kla9555@gmail.com>
Date: Mon, 10 Mar 2025 08:13:09 +0100
Subject: [PATCH] Clarify OVERLEAF_OIDC_USER_ID_FIELD parameter usage (closes
 #24)

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 6c9b6be287..03279f1953 100644
--- a/README.md
+++ b/README.md
@@ -800,6 +800,7 @@ The values of the following two required variables will be provided by the admin
 
 - `OVERLEAF_OIDC_USER_ID_FIELD`
     * The value of this attribute will be used by Overleaf as the external user ID, defaults to `id`.
+      Other possible reasonable values are `email` and `username` (corresponding to `preferred_username` OIDC claim).
 
 - `OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN`
     * If set to `true`, updates the user `first_name` and `last_name` field on login,