All Apps

From the all apps feature, you can access a list of apps that are registered with this data provider. This table shows you the name of the app, its status (enabled, disabled, or needs review), category, and user count. You can filter this table by app status and category or search by app name. In the navigation menu, under your institution name and logo, you will also see whether your institution’s account is enabled for the data provider and whether apps that you register with the data provider are automatically or manually approved by the provider.

​

Add an App

To add an app:

1. From the All apps section, select Add.
2. Upload a logo for the app.
3. Enter the app’s name.
4. Enter the app’s redirect URI. End users will be redirected here after authenticating with the data provider.
5. Select which categories the app falls under, or enter a new category.
6. Select Save.

If the data provider requires a manual review of your apps, the app will be created with a status of Needs review.

​

View an App’s Details

To view an app’s details:

1. Select the app from All apps table; this will bring up an App info section and a Logs section.

Under App info, you’ll see the app’s name, redirect URI, and category. You can also see the client ID and client secret. Under Logs, you’ll see the API requests made from this app to the data provider during the past week. The requests table includes the timestamp, HTTP method, endpoint URI, HTTP status, and request duration. You can filter the logs by time frame (24 hours, 3 days, or 7 days), status, and method.

​

Edit an App’s Details

To edit an app:

1. Select the app from the All apps table.
2. Under App Info, select Edit.
3. Edit one or more of the following:
   • Name: The name of the app.
   • App icon: The app’s logo.
   • Redirect URI: The location the end user will be redirected to after authentication with the provider.
   • Category: The app type.
4. Select Save.

​

Export a CSVof Logs for an App

To export a CSV of request logs for a specific app:

1. Select the app from All apps table.
2. Under the Logs section, select Export.

​

View or Rotate an App’s Registration Key

To view or rotate your app’s registration key:

1. Select the arrow to the right of your app’s logo; the section will expand and display your masked key.
2. From here, you can display your unmasked key or rotate your key to create a new one.

​

Delete an App

Deleting an app will remove the app completely – it will no longer be able to make API requests to the provider, and you won’t be able to view the app’s information or logs in the portal. To delete an app:

1. Select the app from the All apps table.
2. Select Delete.