Roster Data Integrations for Org Admins

9.2.1. Activation of Integration

To add a new integration:

  1. Open the Catalog by selecting Catalog>Product Connectors. See The Catalog Screen (opens a new article).

  2. In the Filter by column on the left, check the Roster Data Integrations checkbox in the Types area.

The Catalog screen refreshes to show only RDI Resources.

  1. Add the desired RDI Resources to the desired Organization as described in Activating Resources(opens a new article).

  2. Select Integrations > Roster Data Integrations to open the Roster Data Integrations screen.

  3. Use the Organization pull-down menu to select the Organization for which you activated  Resource in Step 3.

  4. Find the newly-added Resource in the Service list, click the Manage Permissions link for that Resource, and then adjust the permissions as desired. See Managing Permissions.

  5. In the Status column, click the gray Activate button then a product is activated automatically.

NOTE:  Only school admin with appropriate permissions can activate RDI product.

9.2.2. Management for Educational Organizations

For educational Organizations, the Roster Data Integrations screen allows you to:

  • View Roster Data Integration services (activated from the Catalog, as described in Activating Resources and Adding a New Integration; links open new articles) for Partners or Ecosystem Partners that can access your roster information using API calls.

  • Manage access permissions for each service.

  • View access history for each service.

  • Activate/deactivate service access to roster data.

You can view integrations by using the Organization pull-down menu to select the Organization for which you want to view integration. The table on this screen contains the following information:

  • Service: Name of the service.

  • Activated By: First name and Family name of the administrator who activated RDI Resources and date when he performed it.

  • Manage Permissions: Clicking this link opens the Manage Permissions popup, which allows you to allow/deny access to various types of information. See Managing Permissions (opens a new article)

  • View History: Clicking this link opens the History popup, which contains the following columns:

    • Time: Date and time of the API call.

    • Request URI and Data: API request from the partner to SSO Passport and JSON response to the partner’s request.

  • Status: This can be either Active (partners can access roster data for this Organization) or Inactive (partners cannot access roster data for this Organization).

    • To activate an inactive integration, click the gray Activate button for the Organization you want to activate. The red Inactive button turns green and displays Active.

    • To deactivate an active integration, click the gray Inactivate button for the Organization you want to deactivate. The green Active button turns red and displays Inactive.

See Managing Integrations (Organization) for more information about how educational Organizations can manage integrations (opens a new article).

9.2.3. Managing Permissions

Clicking Manage Permissions for a service opens the Manage Permissions popup for that service.

  • To expose a data attribute to the third-party partner, check the appropriate checkbox in the Expose to partner column.

  • To hide a data attribute from the third-party partner, clear the appropriate checkbox in the Expose to partner column.

  • Mandatory data attributes have a red asterisk (*). You cannot prevent the partner from accessing mandatory data attributes.

When you have finished adjusting permissions, you may either:

  • Click Save & Approve to save the permissions and auto-activate the integration.

  • Click Save to save your changes without automatic activation of the integration.