Tutorial: Configure Segment for automatic user provisioning

This tutorial describes the steps you need to perform in both Segment and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Segment using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.

Capabilities Supported

• Create users in Segment
• Remove users in Segment when they do not require access anymore
• Keep user attributes synchronized between Azure AD and Segment
• Provision groups and group memberships in Segment
• Single sign-on to Segment (recommended)

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

• An Azure AD tenant
• A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
• A user account in Segment with Owner permissions.
• Your workspace must have SSO enabled (requires a Business Tier subscription).

Step 1. Plan your provisioning deployment

1. Learn about how the provisioning service works.
2. Determine who will be in scope for provisioning.
3. Determine what data to map between Azure AD and Segment.

Step 2. Configure Segment to support provisioning with Azure AD

1. The Tenant URL is https://scim.segmentapis.com/scim/v2. This value will be entered in the Tenant URL field in the Provisioning tab of your Segment application in the Azure portal.

2. Login to Segment app.

3. On the left panel, navigate to Settings > Authentication > Advanced Settings.

   

4. Scroll down to SSO Sync and click on Generate SSO Token.

   

5. Copy and save the Bearer token. This value will be entered in the Secret Token field in the Provisioning tab of your Segment application in the Azure portal.

   

Step 3. Add Segment from the Azure AD application gallery

Add Segment from the Azure AD application gallery to start managing provisioning to Segment. If you have previously setup Segment for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.

Step 4. Define who will be in scope for provisioning

The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

• Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

• If you need additional roles, you can update the application manifest to add new roles.

Step 5. Configure automatic user provisioning to Segment

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.

To configure automatic user provisioning for Segment in Azure AD:

1. Sign in to the Azure portal. Select Enterprise Applications, then select All applications.

   

2. In the applications list, select Segment.

   

3. Select the Provisioning tab.

   

4. Set the Provisioning Mode to Automatic.

   

5. Under the Admin Credentials section, input your Segment Tenant URL and Secret Token retrieved earlier in Step 2. Click Test Connection to ensure Azure AD can connect to Segment. If the connection fails, ensure your Segment account has Admin permissions and try again.

   

6. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.

   

7. Select Save.

8. Under the Mappings section, select Synchronize Azure Active Directory Users to Segment.

9. Review the user attributes that are synchronized from Azure AD to Segment in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Segment for update operations. If you choose to change the matching target attribute, you will need to ensure that the Segment API supports filtering users based on that attribute. Select the Save button to commit any changes.

   Attribute	Type	Supported for Filtering
   userName	String	✓
   emails[type eq "work"].value	String
   displayName	String

10. Under the Mappings section, select Synchronize Azure Active Directory Groups to Segment.

11. Review the group attributes that are synchronized from Azure AD to Segment in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Segment for update operations. Select the Save button to commit any changes.

    Attribute	Type	Supported for Filtering
    displayName	String	✓
    members	Reference

12. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

13. To enable the Azure AD provisioning service for Segment, change the Provisioning Status to On in the Settings section.

    

14. Define the users and/or groups that you would like to provision to Segment by choosing the desired values in Scope in the Settings section.

    

15. When you are ready to provision, click Save.

    

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.

Step 6. Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

1. Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
2. Check the progress bar to see the status of the provisioning cycle and how close it is to completion
3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

Additional resources

• Managing user account provisioning for Enterprise Apps
• What is application access and single sign-on with Azure Active Directory?

Next steps

• Learn how to review logs and get reports on provisioning activity