Update OAuth2 configuration documentation for clarity and response format

hasit · hasit · commit 738f77456e21 · 2025-02-17T17:58:36.000-08:00
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -70,7 +70,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
 AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
 
 # OAuth2 Configuration (optional)
-# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT.
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+#   "access_token": "<access-token>",
+#   "token_type": "Bearer",
+#   "expires_in": 3599,
+# }
 OAUTH2_ENDPOINT=[<endpoint>]
 OAUTH2_CLIENT_ID=[<client-id>]
 OAUTH2_CLIENT_SECRET=[<client-secret>]
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -62,7 +62,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
 AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
 
 # OAuth2 Configuration (optional)
-# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT.
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+#   "access_token": "<access-token>",
+#   "token_type": "Bearer",
+#   "expires_in": 3599,
+# }
 OAUTH2_ENDPOINT=[<endpoint>]
 OAUTH2_CLIENT_ID=[<client-id>]
 OAUTH2_CLIENT_SECRET=[<client-secret>]
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -73,7 +73,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
 AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
 
 # OAuth2 Configuration (optional)
-# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT.
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+#   "access_token": "<access-token>",
+#   "token_type": "Bearer",
+#   "expires_in": 3599,
+# }
 OAUTH2_ENDPOINT=[<endpoint>]
 OAUTH2_CLIENT_ID=[<client-id>]
 OAUTH2_CLIENT_SECRET=[<client-secret>]
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -68,7 +68,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
 AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
 
 # OAuth2 Configuration (optional)
-# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT.
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+#   "access_token": "<access-token>",
+#   "token_type": "Bearer",
+#   "expires_in": 3599,
+# }
 OAUTH2_ENDPOINT=[<endpoint>]
 OAUTH2_CLIENT_ID=[<client-id>]
 OAUTH2_CLIENT_SECRET=[<client-secret>]
