Single Sign On with Microsoft account
IAM Provider: Microsoft Azure - Active Directory (AD).
Overview
-
Use case - You want to use your Microsoft Azure / organization email to access our platform.
-
Pre-requisites:
- Configure your Azure AD enterprise application to request our authorization service for authentication.
- See point #2.3. in the “Steps involved” section below.
- Register this application in our platform.
- For identifying your Microsoft Azure enterprise application.
- See point #4. in the “Steps involved” section below.
- Configure your Azure AD enterprise application to request our authorization service for authentication.
For further details on this process visit the page for OIDC Protocol in Microsoft Azure AD
Steps involved:
- Create an enterprise application in Microsoft Azure AD.
- Step by step guide
- Example of this process
- After creation, you can see this listed in Azure AD homepage, option: Enterprise Applications (under “Manage”).
- For example: refer to screenshot #2, in the Screenshots section below.
-
Configure authentication for this application in Microsoft Azure AD
- Click on Authentication (under “Manage”) and do below three steps.
- For example: refer to screenshot #2, in the Screenshots section below.
- Create a Secret Key for this application and copy it somewhere safe.
- Do this by clicking the link next to Client credentials.
- Required for step 6, below.
- Redirect your application to our authorization endpoint for authentication.
- Do this by clicking the link next to “Redirect URIs
- Then add our authorization endpoint (URL below):
https://matrixsso.smartclean.io/oauth2/idpresponse
- This fulfils the first pre-requisite (1/2)
- Click the Endpoints tab and copy the URL of “the OpenID Connect metadata document” (OIDC config URL) somewhere safe.
- Required for the next step.
- Refer to Screenshot #3, below.
- Click on Authentication (under “Manage”) and do below three steps.
- Provide your SmartClean account representative this Application Secret and OIDC config URL
- This allows us to register your Microsoft Azure AD enterprise application.
- Fulfils the second pre-requisite (2/2)
- Our platform will request the following scopes when authentication is required:
- Open ID
- user.read
Outcome:
Your HR team or your IT admin can now allocate appropriate users in your directory to access the application through their registered email addresses in your domain.
Notes
Known issue with Azure AD version 1 and version 2 in Manifest of your enterprise application:
- The Manifest file may show null or “1” as the value for the key “accessTokenAcceptedVersion”
- For example: refer to screenshot #4, in the Screenshots section below.
This requires the OIDC discovery URL to be https://sts.windows.net/<tenant id>
or https://sts.windows.net/<tenant id>/v2.0
since the issuer (iss) is different.
Resolution:
- To allow the issuer to be properly set based on the endpoints shown in your application, please update the Manifest (to highlight the version as 2).
- In this case, Matrix will use the OIDC discovery URL as
https://login.microsoftonline.com/<tenant id>/v2.0
for IAM federation.
Screenshots
Below are some screenshots for an example Enterprise Application in Azure AD.
- The enterprise application is called: Matrix SmartClean CSM Team
- This is created by the organization SMARTCLEAN TECHNOLOGIES PTE LTD