Single sign-on (SSO)
Microsoft Entra ID (Azure AD) OIDC SSO Integration
This guide explains how to integrate Microsoft Entra ID (Azure AD) with your platform using OpenID Connect (OIDC) for Single Sign-On (SSO). It also provides detailed steps for customers to obtain the necessary configuration data from their Microsoft Entra ID tenant.
Prerequisites
Before starting, ensure you have:
- Access to the Microsoft Entra Admin Center with permissions to register applications.
- A valid Microsoft Entra ID tenant.
- Admin credentials for your organization’s Microsoft Entra ID tenant.
Steps for Customers to Obtain Configuration Data
Follow these steps to retrieve the required information from Microsoft Entra ID.
Step 1: Register an Application in Microsoft Entra ID
- Log in to the Microsoft Entra Admin Center.
- Navigate to App registrations in the left-hand menu.
- Click New registration and fill out the following details:
- Name: Enter a name for your application (e.g.,
Roe-AI SSO Integration App
). - Supported account types: Choose one of the following:
- Accounts in this organizational directory only (Single tenant).
- Accounts in any organizational directory (Multitenant).
- Redirect URI: Under Web, enter the URL of Roe-AI callback endpoint
https://app.roe-ai.com/sso/callback
.
- Name: Enter a name for your application (e.g.,
- Click Register to create the application.
Step 2: Retrieve the Client ID and Tenant ID
- After registration, you’ll be redirected to the application overview page.
- Note the Application (client) ID and Directory (tenant) ID from this page. These will be used as the OIDC Client ID and Tenant ID, respectively.
Step 3: Generate a Client Secret
- In the application overview, navigate to Certificates & secrets in the left-hand menu.
- Under Client secrets, click New client secret.
- Add a description (e.g.,
Platform SSO Secret
) and set an expiration period (e.g., 1 year). - Click Add. Once created, copy the Value of the client secret. This will be used as the OIDC Client Secret.
Note: You won’t be able to view this secret again, so copy and store it securely.
Step 4: Configure API Permissions
- Navigate to API permissions in the left-hand menu.
- Click Add a permission and choose Microsoft Graph.
- Select the following permissions:
- Delegated Permissions:
openid
profile
email
offline_access
- Optional: Add
User.Read
if you need to access additional user details.
- Delegated Permissions:
- Click Add permissions.
- Click Grant admin consent for [your tenant name] to grant the necessary permissions.
Step 5: Collect Endpoint URLs
- Go to the Endpoints tab in the Microsoft Entra Admin Center.
- Note the following endpoint URLs:
- Authorization Endpoint: Copy the URL labeled OAuth 2.0 authorization endpoint (v2).
- Token Endpoint: Copy the URL labeled OAuth 2.0 token endpoint (v2).
- User Info Endpoint: Use
https://graph.microsoft.com/v1.0/me
to fetch user details.
Configuration on Your Platform
Once you’ve collected the necessary information from Microsoft Entra ID, configure it on your platform as follows:
Field | Value |
---|---|
OIDC Client ID | The Application (client) ID retrieved from the Azure portal. |
OIDC Client Secret | The Client secret value generated in Step 3. |
OIDC Authorization Endpoint | The OAuth 2.0 authorization endpoint (v2) URL retrieved in Step 5. |
OIDC Token Endpoint | The OAuth 2.0 token endpoint (v2) URL retrieved in Step 5. |
OIDC User Info Endpoint | https://graph.microsoft.com/v1.0/me |
OIDC User Identifier Key | userPrincipalName |
OIDC User First Name Key | givenName |
OIDC User Last Name Key | surname |
Testing the Integration
- Log out of your account on the platform.
- Go to the login page and select Sign in with SSO.
- Authenticate through Microsoft Entra ID.
- Verify that:
- You are redirected back to the platform.
- Your user details (e.g., name, email) are displayed correctly.
Troubleshooting
- Invalid Client ID/Secret:
- Ensure the Client ID and Client Secret are entered correctly.
- Authorization Errors:
- Verify the redirect URI matches the one registered in Microsoft Entra ID.
- User Info Mapping Issues:
- Use a tool like Postman to test the User Info Endpoint (
https://graph.microsoft.com/v1.0/me
) and validate the keys.
- Use a tool like Postman to test the User Info Endpoint (
For further assistance, contact our support team.