To authenticate with the Brightspace APIs using the legacy authentication system, a client application or service requires an Application ID-key pair.To learn about how Application ID-key pair credentials are used during the legacy authentication process, see ID-key authentication.
Note
The information in this topic applies only to Brightspace API client applications using the ID-Key authorization method.
When to register an app¶
We recommend that you request a new App ID-key pair for each separate release version of your application or service that you intend to distribute. This helps ensure that LMS administrators can control access to their services for each version of your application. This can be important if an LMS installation is providing a Learning Framework API version, or limited set of product components, that make their API fundamentally incompatible with your application.
Where to register an app¶
For ID Key Authorization apps, the LMS administrator can directly create Application ID-key pairs using the Manage Extensibility tool within the LMS.
Synchronizing Brightspace with the Keytool¶
Once a day (typically overnight) the list of ID-key Apps in a Brightspace LMS are automatically synchronzied with the Keytool. The synchronization process updates the Keytool as follows:
Removal of any ID-key apps that have been deleted
Adding of any ID-key apps that have been registered
Update of any ID-key apps that have been modified
Manual synchronization can be initiated using the Manage Extensibility tool within the LMS. Within Manage Extensibility > ID Key Authorization click the Refresh button.