Set Up Auto-Provisioning and Banner

Learn how to set up user provisioning to manage users in your application.

Suggest Edits

Auto-provisioning is the feature that allows you to process provisioning and automatically read new roster data for users in your system without logging into School Passport. When a district activates an application with auto-provisioning, a POST request is sent on a webhook containing a parameter districtGUID (new district ID). This unique ID allows you to access district credentials securely through the Partner API and retrieve the latest roster data.

Furthermore, auto-provisioning allows you to use webhooks to directly get potential customers into your system through promotional banners.

📘

Note:

In future releases, the Auto-provisioning will not only read new data, but it will also ensure that these data is kept up-to-date or removed if there are any changes in their status.

🚧

Caution:

To use auto-provisioning, do NOT request first-time district access from your side. If you request access for a district (not vice versa), and that request is approved, your application will activate without auto-provisioning.

Auto-provisioning vs. Auto-approve

There are two automation options in School Passport that enable Vendor Admins to work more efficiently: Auto-provisioning and Auto-approve of data sync consents (auto-approve). It is crucial to avoid any confusion between them.

Auto-approve decides whether access to specified applications will be automatically approved in requests. For example, if a district requests to revoke access to a specific school, School Passport automatically approves this request.

Auto-provisioning, on the other hand, simply uses the webhook URL instead of the default one when the application activates.

Before you begin

  • Contact [email protected] and request this functionality.
  • To retrieve roster data for auto-provisioning, you can utilize GG4L's Data API.
  • To obtain credentials for Data API access, use the Partner API and specify the districtGuid that corresponds to the district undergoing automated provisioning.

Enable auto-provisioning

Once the auto-provisioning was activated for your instance, do the following:

  1. Sign in to School Passport.

  2. Choose an application to manage user provisioning for this specific app.

  3. Browse to Application Settings > Provisioning.

  4. Turn on the Auto-provisioning toggle.

  5. Configure the following connection settings:

    • Webhook URL: Provide a custom URL to which you want to send POST request from School Passport. For example, https://application-host.com/webhook.
    • Header Name and Header Value: Configure custom headers by adding additional key-value data. You can add multiple key-value sets, and you can delete the ones you added by clicking on the trash icon.
    • Add Header: Click and provide additional custom headers.
    • Button: Enter the name of the button that will call your webhook. This button will replace the default one.

  6. (Optional) Test webhook.

  7. (Optional) Create a promotional banner.

  8. Click Save.

When you enable auto-provisioning, the auto-approve is automatically activated.

Test your webhook

Once the webhook is set up, we recommend you test if your application is set up correctly using the test functionality. Otherwise, you may not receive the data in your system.

From the Application Settings > Provisioning tab, click Test Webhook under the header fields. On the Test Webhook window, you can review the full content of the sample HTTP request of School Passport request that will be sent to your target webhook. Click Submit Test to continue.

📘

Note:

Each request contains mode parameter, which defines a behavior of processing the request. The following values are available:

  • test: A special mode that used only for conducting tests. Test mode requests have no impact on the production environment.
  • trial: Uses for conducting trials or special offers. A trial request is created only when application is activated via the promo button.
  • standard: Uses for a regular operational state. A standard request is created when district activates an application via the Auto-provisioning button.

Once the sample webhook request is sent to your configured webhook endpoint, a result is displayed. If the request was received successfully and the HTML response status code from your system was 200, you will see a success message:

Create a banner

Banner creates to encourage districts to use your application. When a potential customer clicks the call-to-action button in your banner, HTTP POST request gets sent to the configured Webhook URL. The potential customer data then goes directly into your target system

After activating auto-provisioning, click Show a promotion banner and configure the banner details. After banner creation, you can preview what the banner will look like to districts in the Application Gallery.

Updated 2 months ago