OAuth Redirect URL breaking change

chris001 · 31 January 2024 08:21

Fix #10345 Microsoft Azure OAuth Redirect URL doesn't allow the query string.

salesagility:hotfix ← chris001:Microsoft-Azure-OAuth-Redirect-URL

opened 08:21AM - 31 Jan 24 UTC

## Description Setting up MS Azure OAuth for email accounts was failing because Suite docs say use a Redirect URL containing a query string, and Azure forbids Redirect URLs with query strings. My fix involves adding a line to the `.htaccess` to rewrite the incoming Redirect URL compatible with Microsoft Azure OAuth, to the query-string type of Redirect URL expected by Suite. ## Motivation and Context Microsoft Azure OAuth does not allow Redirect URL to have query strings, which is the exact type of URL Suite uses. ## How To Test This Try creating an application in Azure according to the documentation. At one point, it will have you paste the Suite Redirect URL into Microsoft Azure application. Paste the URL with query strings from the docs. Azure will refuse to save it because query strings are not allowed. ![Azure OAuth Redirect URL may not coontain a query string](https://github.com/salesagility/SuiteCRM/assets/259416/7554f2a7-a307-401b-9488-afe522417907) Try again with the URL like this instead: `https://suite.mysite.tld/entryPoint/setExternalOAuthToken` Azure will save this Redirect URL. And Suite will accept the Redirect URL during the OAuth email account login, because Suite will internally rewrite the incoming Redirect URL from Azure, to the expected URL `https://suite.mysite.tld/index.php?entryPoint=setExternalOAuthToken`, Suite will receive the token back from Azure OAuth, making OAuth login to the MS Azure email account work. ## Types of changes - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ### Final checklist - [x] My code follows the code style of this project found [here](https://docs.suitecrm.com/community/contributing-code/coding-standards/). - [x] My change requires a change to the documentation. - [x] I have read the [**How to Contribute**](https://docs.suitecrm.com/community/contributing-code/) guidelines.