How do I enable scoping for a developer API key in an account?
As part of creating new developer API keys or editing existing developer API keys in your account, you can customize the access the API key receives. Enforcing scopes allows you to control direct access and specific API endpoints for third-party tools associated with your institution.
By default, scope enforcement is disabled when creating a new developer API key, which allows tokens to access all endpoints available to the authorizing user. However, scopes can be edited for a developer API key at any time and update access tokens for the authorizing user appropriately.
Notes:
- Managing Developer Keys is an account permission. If you cannot manage developer keys, this permission has not been enabled for your user role.
- Developer Keys are not available in subaccounts.
Open Account
In Global Navigation, click the Admin link [1], then click the name of the account [2].
Open Developer Keys
In Account Navigation, click the Developer Keys link.
Add Developer Key
Click the Add Developer Key button.
Add API Key
Click the Add API Key option.
Enforce Scopes
After you've completed the developer key information, click the Enforce Scopes button.
Allow Include Parameters
To permit usage of all "includes" parameters for this key, click the Allow Include Parameters checkbox.
"Includes" parameters may grant access to additional data that is not included in the Endpoints table.
Search Endpoints
To search for a specific endpoint, type the name of the endpoint in the Search Endpoints field [1].
To see all available endpoints, scroll through the Endpoints table [2].
Select Read Only Endpoints
To grant read-only (GET) access to the developer key, select the Read only checkbox. The table will automatically update and select all scopes that contain read-only endpoints.
Select Individual Endpoints
You can grant customized access to the developer API key. Click any scope name to view available endpoints [1]. Select the desired endpoints by clicking the checkbox next to the endpoint name [2]. The scope name line will update to show the summary of the collective selected endpoint access [3].
Save Key
Click the Save button.
