Microsoft Authentication (SSO) Guide¶
Microsoft OAuth allows Agents and Users to sign into the helpdesk with their Microsoft account.
Choose ‘Microsoft’ in the ‘Add New Instance’ menu
Give the instance a name that lets you know which provider is selected and select ‘Enabled’ for the status.
Go to the ‘Config’ tab to set up this provider. Some of the default information will be autofilled.
Note: The ‘Authentication Label’ field is the text that will be displayed to the User or Agent when they sign into the helpdesk.
Choose an Authentication Target to specify who should be able to use this provider.
Now you need to set up an application using your Microsoft account. The first thing you need to do is log in to the Azure Portal. which brings you to your Dashboard.
Note: if you see an authentication issue, it means you are a standard user with restricted access.
In order to use OAuth, you must have an account with administrative access to a tenant or you must be added to a tenant by an administrator.
Next, you’ll need to go to ‘Azure Active Directory’ and click ‘App Registrations’.
Click ‘New Registration’
Name the application and choose the supported account types:
Note: The supported account type will determine the ‘Authorization Endpoint’ and ‘Token Endpoint’ in your osTicket instance.
The Redirect URI can be found in the plugin instance created in osTicket.
Choose Web for the Platform, paste in the Redirect URI, and click Register.
Once you click Register, it will take you to the Overview for your new Application.
Copy the ‘Application (client) ID and paste it into the Client ID field in your osTicket plugin instance:
Go back to Azure and click ‘Add a certificate or secret’
Click ‘New Client Secret’ to generate a new Client Secret
Add a secret description and click ‘Add’
Important: The secret ‘Value’ will only be shown once. If you lose this value, you will have to generate a new one.
Copy the value and paste it into the ‘Client Secret’ field on the osTicket instance:
Now you will need to get the Endpoint values from Azure. Go back to the ‘Overview’ tab and click the ‘Endpoints’ option.
The supported account type chosen will determine the values for the ‘Authorization Endpoint’ and ‘Token Endpoint’ in your osTicket instance.
Single Tenant Endpoints:
Multitenant and Personal Accounts Endpoints:
Personal Microsoft Account Endpoints:
Copy the ‘OAuth 2.0 authorization endpoint (v2)’ and paste it into the ‘Authorization Endpoint’ field in the osTicket instance.
Copy the ‘OAuth 2.0 token endpoint (v2)’ and paste it into the ‘Token Endpoint’ field in the osTicket instance.
The rest of the information should be autofilled in the osTicket instance for you.
Click ‘Add Instance’ and make sure you see a confirmation message.
Now that the setup is complete, you should be able to use your Microsoft account to log into the helpdesk.
To test the functionality for Agents, go to:
Admin Panel | Agents
Ensure that you see the provider that was just set up in the list. It is important, however, to make sure you choose ‘Use any available backend’ so that you can still log into your helpdesk in the event that OAuth has an error.
Note: You must also ensure that the email for the Agent exists in the organization you are setting up OAuth for. You can see your users by going to Azure and clicking the ‘Users’ tab.
Log out of the helpdesk and go to the login screen.
Click the ‘Sign in with Azure’ button to test the OAuth set up.
Note: The sign in button text can be configured by changing the Authentication Label in the osTicket instance setup.
Now you will be prompted to enter your Microsoft account password.
You may see a screen to allow osTicket to use your Microsoft login for the helpdesk.
Click Yes and you should be signed into your helpdesk as an Agent.
For users, logging in with a Microsoft account should create a new User if one does not exist, otherwise, it will log in as an existing User.
Click ‘Sign In’
Click ‘Sign in with Azure’. Now you will be prompted to enter your Microsoft account password.
Choose your account and you should be logged in as a User.