Commit18f729f

authored

Update OAuth2 configuration documentation for clarity and response format (#232)

1 parent8e18121 commit18f729fCopy full SHA for 18f729f

File tree

+32

-4

lines changed

+32

-4

lines changed

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>`
`70`	`70`	`AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]`
`71`	`71`
`72`	`72`	`# OAuth2 Configuration (optional)`
`73`		`-# 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.`
	`73`	`+# This will use client_credentials flow to get an access token,`
	`74`	`+# and use it to make requests to the LLM provider.`
	`75`	`+# It is expected that the response from the OAuth2 server will be in the format`
	`76`	`+# {`
	`77`	`+# "access_token": "<access-token>",`
	`78`	`+# "token_type": "Bearer",`
	`79`	`+# "expires_in": 3599,`
	`80`	`+# }`
`74`	`81`	`OAUTH2_ENDPOINT=[<endpoint>]`
`75`	`82`	`OAUTH2_CLIENT_ID=[<client-id>]`
`76`	`83`	`OAUTH2_CLIENT_SECRET=[<client-secret>]`

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>`
`62`	`62`	`AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]`
`63`	`63`
`64`	`64`	`# OAuth2 Configuration (optional)`
`65`		`-# 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.`
	`65`	`+# This will use client_credentials flow to get an access token,`
	`66`	`+# and use it to make requests to the LLM provider.`
	`67`	`+# It is expected that the response from the OAuth2 server will be in the format`
	`68`	`+# {`
	`69`	`+# "access_token": "<access-token>",`
	`70`	`+# "token_type": "Bearer",`
	`71`	`+# "expires_in": 3599,`
	`72`	`+# }`
`66`	`73`	`OAUTH2_ENDPOINT=[<endpoint>]`
`67`	`74`	`OAUTH2_CLIENT_ID=[<client-id>]`
`68`	`75`	`OAUTH2_CLIENT_SECRET=[<client-secret>]`

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>`
`73`	`73`	`AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]`
`74`	`74`
`75`	`75`	`# OAuth2 Configuration (optional)`
`76`		`-# 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.`
	`76`	`+# This will use client_credentials flow to get an access token,`
	`77`	`+# and use it to make requests to the LLM provider.`
	`78`	`+# It is expected that the response from the OAuth2 server will be in the format`
	`79`	`+# {`
	`80`	`+# "access_token": "<access-token>",`
	`81`	`+# "token_type": "Bearer",`
	`82`	`+# "expires_in": 3599,`
	`83`	`+# }`
`77`	`84`	`OAUTH2_ENDPOINT=[<endpoint>]`
`78`	`85`	`OAUTH2_CLIENT_ID=[<client-id>]`
`79`	`86`	`OAUTH2_CLIENT_SECRET=[<client-secret>]`

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>`
`68`	`68`	`AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]`
`69`	`69`
`70`	`70`	`# OAuth2 Configuration (optional)`
`71`		`-# 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.`
	`71`	`+# This will use client_credentials flow to get an access token,`
	`72`	`+# and use it to make requests to the LLM provider.`
	`73`	`+# It is expected that the response from the OAuth2 server will be in the format`
	`74`	`+# {`
	`75`	`+# "access_token": "<access-token>",`
	`76`	`+# "token_type": "Bearer",`
	`77`	`+# "expires_in": 3599,`
	`78`	`+# }`
`72`	`79`	`OAUTH2_ENDPOINT=[<endpoint>]`
`73`	`80`	`OAUTH2_CLIENT_ID=[<client-id>]`
`74`	`81`	`OAUTH2_CLIENT_SECRET=[<client-secret>]`

Comments

(0)