Set Up Single ssign-on (SSO) Using OpenID Connect (OIDC) for Entra ID
Microsoft Entra ID is a multi-tenant, cloud-based identity management system. Blackbaud provides an option for Entra ID setup, but you can also set up an SSO connection through the OIDC authentication protocol that enables third-party applications to verify end users and specify Entra ID as your IdP. An organization admin (or another user with the necessary admin rights) must claim your organization's email domains, configure the OIDC connection, test the connection, and then turn on SSO.
Tip: Are you sure you want to set up an OIDC connection using Entra ID? Blackbaud recommends our Entra ID setup option that simplifies the configuration and management your SSO connection.
To prevent inadvertent lockouts, make sure to:
-
Complete the setup during a maintenance window for your organization's network.
-
Create a Blackbaud ID outside of your claimed domains with access to the Authentication settings page in Security.
Blackbaud doesn't support IdP-initiated connections. If you need to enable users to connect to Blackbaud solutions through an app in your IdP's portal, then after you turn on SSO, you must configure that app to use the redirect URL for your live connection.
Configure SSO
To set up your SSO connection using OIDC for Entra ID, follow the steps in the following sections:
1. Claim email domains
-
In Security, select Authentication.
-
Under New single sign-on (SSO) on the Authentication settings page, select Manage SSO settings.
-
On the Single sign-on page, select OIDC.
-
Under Claim your email domains, select Claim domains or Edit claimed domains and identify the email domains that your organization uses. This allows you to recognize and redirect users to your IdP when they sign in through your claimed email domains.
Note: You'll receive a confirmation email after we verify your domains. This process usually takes minutes, but in rare cases it can take up to two days. After your domains are verified, you can continue to the next step to configure your connection.
2. Configure the Entra ID connection
-
Under Configure your connection on the Authentication settings page, select Get started or Edit connection. The Configure OIDC application screen appears.
-
In a different browser tab, sign in to your Entra ID portal.
Warning: These instructions include guidance for the Entra ID portal, but Blackbaud doesn't manage that portal. If the portal changes, we recommend Microsoft's official guidance in the Entra ID documentation.
-
Under Azure services, select Microsoft Entra ID.
-
In the menu on the left, select Overview.
-
Under Basic information on the Overview tab, select the copy button beside the tenant ID for your Entra ID portal.
Tip: If your organization's domains cross multiple tenants, we recommend setting your connection name to the tenant ID for your organization. For more options to locate the tenant ID, see How to find your Microsoft Entra tenant ID.
-
-
Return to Blackbaud's Configure OIDC application screen, and in the Connection name field, paste your organization's tenant ID.
-
Beside the Redirect URI field, select Copy to copy the redirect URI (https://id.blackbaud.com/bbid.onmicrosoft.com/oauth2/authresp).
-
Return to the browser tab with your Entra ID portal to register a new application.
-
In the menu on the left, select Manage and then App registrations.
-
On the App registrations page, select New registration.
-
In the Name field, enter a display name to identify your application.
The display name appears at times such as during sign in, and you can edit it as necessary at any time. Multiple app registrations can share a display name because the automatically generated application (client) ID uniquely identifies each app within the identity platform.
-
Under Supported account types, specify the users who can use your application (also known as the sign-in audience). We recommend Accounts in this organizational directory only.
-
Under Redirect URI select Web as the platform and paste the redirect URI that you copied on Blackbaud's Configure OIDC application screen (https://id.blackbaud.com/bbid.onmicrosoft.com/oauth2/authresp).
-
Select Register. Entra ID creates the application.
-
With Overview selected in the menu on the left, select Endpoints at the top of the page.
-
In the list of endpoints that appears, select the copy icon under OpenID Connect metadata document.
-
-
Return to Blackbaud's Configure OIDC connection screen, and in the Metadata URL field, paste the URL for the OIDC metadata document that you just copied. This document contains information that is required during sign-in, such as the URLs to use and the location of the service's public signing keys. The metadata document is always located at an endpoint that ends in ".well-known/openid-configuration."
-
In the Response type field, select the "ID Token" response type that handles the generation of the client secret for SSO.
-
Return to the browser tab with your Entra ID portal with Overview still selected in the menu on the left, and under Essentials, select the copy button beside the application (client) ID.
-
Return to Blackbaud's Configure OIDC connection screen, and in the Client ID field, paste the client ID that you just copied for your Entra ID application.
-
If you set the response type to "Code" instead of the recommended "ID Token" response type in the Response type field, two additional fields appear.
-
In the Client secret field, enter the client secret for your OIDC project.
-
In the Expiration date field, enter the expiration date of your client secret. This field only appears for Entra ID connections where the metadata URL starts with "https://login.microsoftonline.com/" and the response type is set to "Code."
-
-
In the fields under Confirm how your IdP identifies the following, specify where you store the data that your IdP uses to identify your organization's users. These values must match the mapping values in your the Entra ID application.
Warning: You can only pass mapping fields if they are included under "claims_supported" in the OIDC metadata document that you provided in the Metadata URL field. That document, which ends in ".well-known/openid-configuration," contains information that is required during sign-in, such as the fields where you store data that identifies your users.
-
In the NameID field, enter "sub." This is the default claim name that Entra ID uses to store the unique IDs that identify your users, and it can't be edited.
We recommend against using a different value, such as email addresses, to identify users. If you identify users by email address and need to change a user's email address, then you must re-invite the user at the new email address, which means you lose all history associated with the original one.
-
In the Email address field, specify where you store user email addresses. The common claim name for this field for Entra ID is "email." Alternately, to map this field to the user principle name (UPN), enter "preferred_username."
For successful connections, email addresses must be unique.
-
To map first and last names, return to the browser tab with your Entra ID portal.
Tip: You only need to complete this step and the next two mapping steps if you want usernames from your IdP to show up in Blackbaud. If not, you can skip ahead to step 11.
-
In the menu on the left, select Manage and then select Token configuration.
-
On the Optional claims page, select Add optional claim.
-
Under Add optional claim, select ID.
-
In the Claim column, select family_name and given_name.
-
Select Add.
-
-
Add permissions for the first and last name mappings.
-
In the menu on the left, select Manage and then select API permissions.
-
Under Configured permissions on the API permissions page, select Add a permission.
-
In the list of options that appears, select Microsoft Graph under Commonly used Microsoft APIs on the Microsoft APIs tab.
-
Select Delegated permissions.
-
In the Permission column, select profile.
-
Select Add permissions.
-
-
Return to Blackbaud's Configure OIDC connection screen to map the fields.
-
In the First name field, enter "given_name" to specify where you store first names.
-
In the Last name field, enter "family_name" to specify where you store first names.
-
-
-
Select the checkbox that acknowledges the need to wait before testing your SSO connection.
-
If you are setting up SSO for the first time, select I acknowledge these settings require 24 hours to take effect. A notification will let you know when your SSO connection is ready to test.
-
If you are editing an existing SSO connection, select I acknowledge these changes can take up to 30 minutes to take effect. We recommend waiting 30 minutes before you test the connection.
-
-
Select Save.
3. Test connection
When you save your configuration settings, test mode is turned on automatically. At least one user must successfully sign in using test mode before you can enable your SSO connection.
To verify that your organization can use your IdP to sign in to Blackbaud solutions, select Learn about testing SSO under Test connection. Then copy the URL under Blackbaud ID redirect and test your connection in a private or incognito browser window.
Note: If a consent screen appears in test mode, that means your IdP is configured to require admin approval before users authenticate. This consent screen is for the Blackbaud SSO application and is not requesting new permissions or access. It is seeking read-access to the user information that you already configured as part of your SSO setup. To proceed, follow the instructions on your IdP's consent screen.
When you turn off test mode, an Erase all single sign-on settings option appears under Configure your connection so that you can clear your configuration settings and start over. For example, you can select the option if you decide to use a different connection method or if you need to troubleshoot an issue and start over. The option is no longer available when you turn on SSO, but you can turn off SSO to make it available again.
4. Turn on SSO
To complete the connection to your IdP, select Turn on SSO under Turn on on the Authentication settings page. Then on the Connect your OIDC SSO screen, select Connect with OIDC.
After you turn on SSO, users are redirected to your IdP when they sign in to their Blackbaud IDs with one of your claimed domains. After they authenticate through your IdP, their Blackbaud IDs:
-
Automatically redirect them to your organization's login for future sign-ins.
After users sign in through your organization's login, they are redirected to their Blackbaud profiles unless you edit the redirect URL to specify a Blackbaud solution.
Tip: Don't forget that if your users use an app in your IdP's portal to connect to Blackbaud solutions, you must configure that app to use the redirect URL for your live connection.
-
Use your IdP for password updates, lockouts, and other authentication management.
Note: After you enable SSO, resend any pending invitations.