Tutorial: Configure SchoolStream ASA for automatic user provisioning in SchoolStream ASA

This tutorial describes the steps you need to perform in both SchoolStream ASA and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users and groups to SchoolStream ASA using the Microsoft Entra 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 Microsoft Entra ID.

Capabilities Supported

• Create users in SchoolStream ASA
• Remove users in SchoolStream ASA when they do not require access anymore.
• Keep user attributes synchronized between Microsoft Entra ID and SchoolStream ASA.
• Provision groups and group memberships in SchoolStream ASA.
• Single sign-on to SchoolStream ASA (recommended).

Prerequisites

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

• A Microsoft Entra tenant
• One of the following roles: Application Administrator, Cloud Application Administrator, or Application Owner.
• A SchoolStream Website. Please contact SchoolStream support if you do not have one.

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 Microsoft Entra ID and SchoolStream ASA.

Step 2: Configure SchoolStream ASA to support provisioning with Microsoft Entra ID

1. Contact SchoolStream support to request SchoolStream ASA integration, you will need to provide your Microsoft Entra tenant Id and your SchoolStream Website URL.

2. You will get your Secret Token and SchoolStream ASA Tenant URL after SchoolStream has mapped your SchoolStream Website and Microsoft Entra tenant ID.

Step 3: Add SchoolStream ASA from the Microsoft Entra application gallery

To start managing provisioning to SchoolStream ASA in your Microsoft Entra ID, you need to add SchoolStream ASA from the Microsoft Entra application gallery.

1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
2. Browse to Identity > Applications > Enterprise applications > New application.
3. In the Browse Microsoft Entra Gallery section, type SchoolStream ASA in the search box.
4. Select SchoolStream ASA from results panel and then Sign up for the app. Wait a few seconds while the app is added to your tenant.

If you have previously setup SchoolStream ASA 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 Microsoft Entra 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 SchoolStream ASA

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users and/or groups in SchoolStream ASA based on user and/or group assignments in Microsoft Entra ID.

To configure automatic user provisioning for SchoolStream ASA in Microsoft Entra ID:

1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

2. Browse to Identity > Applications > Enterprise applications

   

3. In the applications list, select SchoolStream ASA.

   

4. Select the Provisioning tab.

   

5. If you are configuring provisioning for the first time, select Get started.

6. Set the Provisioning Mode to Automatic.

   

7. In the Admin Credentials section, input your SchoolStream ASA Tenant URL and Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to SchoolStream ASA. If the connection fails, ensure your SchoolStream ASA account has Admin permissions and try again.

   

8. Select Save to see the Settings section.

9. In the Notification Email field of Settings section, 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.

   

10. In the Mappings section, select Provision Microsoft Entra users.

11. Select Add New Mapping at the bottom.

12. In the dialog Edit Attribute:

    • In the Mapping type field, select Direct from the dropdown,

    • In the Source attribute field, select extensionAttribute1 from the dropdown,

    • Enter your Microsoft Entra tenant Id in the field Default value if null(optional),

    • In the Target attribute field, select urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization from the dropdown,

    • In the Match objects using this attribute field, select No from the dropdown,

    • In the Apply this mapping field, select Always from the dropdown,

    • Select OK.

      

13. Review the user attributes that are synchronized from Microsoft Entra ID to SchoolStream ASA in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in SchoolStream ASA for update operations. If you choose to change the matching target attribute, you will need to ensure that the SchoolStream ASA API supports filtering users based on that attribute.

    Attribute	Type	Supported for filtering
    userName	String	✓
    active	Boolean
    displayName	String
    emails[type eq "work"].value	String
    preferredLanguage	String
    name.givenName	String
    name.familyName	String
    name.formatted	String
    phoneNumbers[type eq "mobile"].value	String
    externalId	String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization	String

14. Under the Mappings section, select Synchronize Microsoft Entra groups to UNIFI.

15. Review the group attributes that are synchronized from Microsoft Entra ID to UNIFI in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in UNIFI for update operations. Select the Save button to commit any changes.

    Attribute	Type	Supported for filtering
    displayName	String	✓
    members	Reference
    externalId	String

16. Select the Save button to commit any changes. You can go back to the Application tab and select Edit provisioning to continue.

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

18. To enable the Microsoft Entra provisioning service for SchoolStream ASA, change the Provisioning Status to On in the Settings section.

    

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

    

20. 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 Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

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

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

Change log

• 09/24/2020 - Group provisioning got enabled.

More resources

• Managing user account provisioning for Enterprise Apps
• What is application access and single sign-on with Microsoft Entra ID?

Next steps

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