View OAuth Client Credentials
PowerSchool uses OAuth 2.0 to secure the data exchange features of a plugin. If you have installed a plugin that uses data exchange, PowerSchool auto-generates the plugin's client credentials. The client credentials are required for the external system to retrieve an access token for data exchange. This is sensitive data and should be kept secure to prevent unauthorized access to PowerSchool data.
PowerSchool is capable of sending the client credentials to the external system automatically if the publisher of the plugin has set up the system to handle automatic registration. If a plugin does not support automatic registration, then it will be necessary for you to manually send the client credentials to the publisher before the external system will be able to use the data exchange features.
Note: This procedure is only applicable if the plugin configuration file you installed includes OAuth configuration information.
- On the start page, choose System under Setup in the main menu.
- Under Server, click System Settings.
- Click Plugin Management Configuration.
- Click the name of the plugin you want to configure.
- Click Data Provider Configuration.
Use the following table to view information on the OAuth Credentials section:
Field
Description
Client ID
A value that uniquely identifies the plugin.
Client Secret
The account identifier associating the API client record to the client credentials.
- Click OK.
Regenerate Client ID and Secret
This function should be used if the API services credentials have been compromised or you suspect they have been compromised, you can use this procedure to regenerate the API services credentials.
The following procedure works for version 21.11.2.0 and later. For any versions older than 21.11.2.0, you should delete the plugin, reinstall it, and reenable it.
- On the start page, choose System under Setup in the main menu.
- Under Server, click System Settings.
- Click Plugin Management Configuration.
- Click the plugin name for which you want to reset the OAuth credentials.
- Click Data Provider Configuration
- Click Regenerate Client ID and Secret.
- Click Confirm Regenerate Client ID and Secret.