!!! ATTENTION EVERYONE !!!

A new build of the OAuth2 plugin with full support for all types of emails is now live on the downloads page.

** IMPORTANT NOTES: **

  • This requires you to apply a patch for the core codebase.
  • After installing the new build of plugin you should update all emails using OAuth2 just to be certain you are up-to-date.
  • If you are currently using the un-PHARed plugin make sure you update the database and set the install_path and isphar values back to their original values (ie. plugins/auth-oauth2.phar and 1 respectively).

Follow the below steps to ensure you are up-to-date with the Microsoft changes:

  • Login to osTicket in incognito/private browsing window (repeat for each email to prevent authorizing the wrong account each time)
  • Click on a system email with OAuth2 configured
  • Click Config in Remote Mailbox tab
  • If using hared mailbox/resource email/alias email ensure the Strict Matching checkbox is disabled (unchecked) in the Info tab
  • Fully replace the Scopes value with offline_access https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All https://outlook.office.com/SMTP.Send
  • Submit the popup
  • Login as the email itself -OR- if using shared mailbox/resource email/alias email sign in to the Service Account/User Account that has full Send As and Read and Manage permissions to the mailbox
  • Consent to the requested permissions
  • Once complete you should be redirected back to osTicket with a success banner. If however you are using a shared mailbox/resource email/alias email and you get an error about mismatching emails on the first submission, simply resubmit the popup and it should go through the second time.
  • Repeat these steps for the Outgoing SMTP tab if it has separate OAuth2 Authentication configured (ie. if SMTP Authentication is set to "OAuth2 - Microsoft")

Once you have a new token you should be good to go. 🫡

Just to note, a new set of releases for both 1.17.x and 1.18.x will be released soon that will contain the above core codebase patch.

    If we are using OSTICKET on a hosting provider i.e Krystal UK how do we apply the changes on the backend, before doing the GUI changes?

      martinleggott

      You would need to contact your hosting provider as each provider is different. Depends on if they have CPanel, or SSH, etc.

      Cheers.

        martinleggott

        But once you get access to your backend you can upload the new build of plugin to the include/plugins/ folder of your osTicket site overwriting the currently installed PHAR file. Then modify the needed core codebase files shown in the referenced pull request. You can modify the file with any editor you are comfortable with. If you aren’t comfortable doing so GitHub allows you to view and download the full files in the pull request. Go to the pull request, click Files Changed, click the three dots on the bar with the file name in it, click View File, click the three dots on the bar with Code/Blame, click Download (or press Ctrl + Shift + S), and upload the file to the matching location in your site folder overwriting the existing file. Repeat for each file in the pull request until you have replaced all the needed files. From there you should be good to go to follow the GUI steps.

        Cheers.

          after Doing all steps , after authenticated the email , it return to ostickets home page , not the email configuration page

            KevinTheJedi
            Just to make sure I am understanding correctly
            Downloading new OAuth2 plugin and installing then applying this? This requires you to apply a patch for the core codebase.
            or before installing new OAuth2 plugin?

                tamer229

                That doesn’t really help much. Things can change, secrets can expire, etc. I would recommend going over the PHP changes you made to ensure you did them correctly. Then double check your plugin and app registration settings as shown in the docs. If you still have issues I’d recommend configuring a new app registration and reconfiguring the email in osTicket.

                Cheers.

                  I've only had to upload the new th-oauth2.phar and then as soon as i re-apply the token it was successful and started pulling down emails again.?!

                    Thanks a million! Our helpdesk is back! Thanks Kevin and team, as well as community!

                    Ok I have tried for 3 hours now and I can't get the token to work, I keep getting this message:
                    Credentials: Required option not passed: "access_token"
                    I have the same issue as a user above where after connecting to Microsoft it just returns to the homepage for OSTicket.

                      chris-plahn

                      Sounds like something is misconfigured within the email configurations or app registration. I would recommend creating a new app registration by following the steps in the documentation, replacing the needed information in the email configurations to match the new app, replace the Scopes with the ones I posted above, and then submit the popup. Keep in mind you should be doing so in an incognito/private window to avoid authorizing the wrong account.

                      Cheers.

                          chris-plahn

                          So you have done ALL of the following and still have issues?

                          • Downloaded the new build of OAuth2 plugin from the osTicket download page.
                          • Replaced your existing auth-oauth2.phar file with the new one.
                          • You’ve made these changes in your code.
                          • You’ve restarted your web server (and PHP-FPM if you’re running it) to clear any server-side file caching. If using a hosting provider they will likely have additional file caching and if that’s the case reach out to ask how to clear said cache.
                          • Opened an incognito/private window.
                          • Navigated to your system email in osTicket.
                          • Clicked Remote Mailbox and clicked Config.
                          • Deleted the existing token (if one).
                          • Clicked IdP Config.
                          • Replaced the Scopes with offline_access https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All https://outlook.office.com/SMTP.Send.
                          • Submitted the popup.
                          • Logged in as the email you are configuring in osTicket.
                          • Consented to the permissions.
                          • Redirected back to the email in osTicket with a success banner.

                          If so then I’m not sure what’s happening and you would simply need to post everything you have so we can try to help you. I simply cannot replicate this.

                          Cheers.

                              KevinTheJedi
                              Yesterday we ran in this problem, after editing the plugin its working fine.
                              We're using exchange online usermailbox with 2FA.

                              Thanks.