Tutorial: Integrate Civic Platform with Azure Active Directory
In this tutorial, you'll learn how to integrate Civic Platform with Azure Active Directory (Azure AD). When you integrate Civic Platform with Azure AD, you can:
- Control in Azure AD who has access to Civic Platform.
- Enable your users to be automatically signed-in to Civic Platform with their Azure AD accounts.
- Manage your accounts in one central location - the Azure portal.
To learn more about SaaS app integration with Azure AD, see What is application access and single sign-on with Azure Active Directory.
To get started, you need the following items:
- An Azure AD subscription. If you don't have a subscription, you can get one-month free trial here.
- Civic Platform single sign-on (SSO) enabled subscription.
In this tutorial, you configure and test Azure AD SSO in a test environment.
- Civic Platform supports SP initiated SSO
Adding Civic Platform from the gallery
To configure the integration of Civic Platform into Azure AD, you need to add Civic Platform from the gallery to your list of managed SaaS apps.
- Sign in to the Azure portal using either a work or school account, or a personal Microsoft account.
- On the left navigation pane, select the Azure Active Directory service.
- Navigate to Enterprise Applications and then select All Applications.
- To add new application, select New application.
- In the Add from the gallery section, type Civic Platform in the search box.
- Select Civic Platform from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
Configure and test Azure AD single sign-on
Configure and test Azure AD SSO with Civic Platform using a test user called B.Simon. For SSO to work, you need to establish a link relationship between an Azure AD user and the related user in Civic Platform.
To configure and test Azure AD SSO with Civic Platform, complete the following building blocks:
- Configure Azure AD SSO - to enable your users to use this feature.
- Configure Civic Platform SSO - to configure the Single Sign-On settings on application side.
- Create an Azure AD test user - to test Azure AD single sign-on with B.Simon.
- Assign the Azure AD test user - to enable B.Simon to use Azure AD single sign-on.
- Create Civic Platform test user - to have a counterpart of B.Simon in Civic Platform that is linked to the Azure AD representation of user.
- Test SSO - to verify whether the configuration works.
Configure Azure AD SSO
Follow these steps to enable Azure AD SSO in the Azure portal.
In the Azure portal, on the Civic Platform application integration page, find the Manage section and select Single sign-on.
On the Select a Single sign-on method page, select SAML.
On the Set up Single Sign-On with SAML page, click the edit/pen icon for Basic SAML Configuration to edit the settings.
On the Basic SAML Configuration section, enter the values for the following fields:
a. In the Sign on URL text box, type a URL using the following pattern:
b. In the Identifier (Entity ID) text box, type a URL:
The Sign on URL value is not real. Update this value with the actual Sign on URL. Contact Civic Platform Client support team to get this value. You can also refer to the patterns shown in the Basic SAML Configuration section in the Azure portal.
On the Set up Single Sign-On with SAML page, In the SAML Signing Certificate section, click copy button to copy App Federation Metadata Url and save it on your computer.
Navigate to Azure Active Directory > App registrations in Azure AD, select your application.
Copy the Directory (tenant) ID and store it into Notepad.
Copy the Application ID and store it into Notepad.
Navigate to Azure Active Directory > App registrations in Azure AD, select your application. Select Certificates & secrets.
Select Client secrets -> New client secret.
Provide a description of the secret, and a duration. When done, select Add.
After saving the client secret, the value of the client secret is displayed. Copy this value because you aren't able to retrieve the key later.
Configure Civic Platform SSO
Open a new web browser window and sign into your Atlassian Cloud company site as an administrator.
Click on Standard Choices.
Create a standard choice ssoconfig.
Search for ssoconfig and submit.
Expand SSOCONFIG by clicking on red dot.
Provide SSO related configuration information in the following step:
In the applicationid field, enter the Application ID value, which you have copied from the Azure portal.
In the clientSecret field, enter the Secret value, which you have copied from the Azure portal.
In the directoryId field, enter the Directory (tenant) ID value, which you have copied from the Azure portal.
Enter the idpName. Ex:-
Create an Azure AD test user
In this section, you'll create a test user in the Azure portal called B.Simon.
- From the left pane in the Azure portal, select Azure Active Directory, select Users, and then select All users.
- Select New user at the top of the screen.
- In the User properties, follow these steps:
- In the Name field, enter
- In the User name field, enter the firstname.lastname@example.org. For example,
- Select the Show password check box, and then write down the value that's displayed in the Password box.
- Click Create.
- In the Name field, enter
Assign the Azure AD test user
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Civic Platform.
In the Azure portal, select Enterprise Applications, and then select All applications.
In the applications list, select Civic Platform.
In the app's overview page, find the Manage section and select Users and groups.
Select Add user, then select Users and groups in the Add Assignment dialog.
In the Users and groups dialog, select B.Simon from the Users list, then click the Select button at the bottom of the screen.
If you're expecting any role value in the SAML assertion, in the Select Role dialog, select the appropriate role for the user from the list and then click the Select button at the bottom of the screen.
In the Add Assignment dialog, click the Assign button.
Create Civic Platform test user
In this section, you create a user called B.Simon in Civic Platform. Work with Civic Platform support team to add the users in the Civic Platform Client support team. Users must be created and activated before you use single sign-on.
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
When you click the Civic Platform tile in the Access Panel, you should be automatically signed in to the Civic Platform for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.