How do I enable scoping for a developer key in an account?

Document created by Canvas Doc Team Employee on Jul 14, 2018Last modified by Canvas Doc Team Employee on Dec 8, 2018
Version 8Show Document
  • View in full screen mode

As part of creating new developer keys or editing existing developer keys in your account, you can customize the access the 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 key, which allows tokens to access all endpoints available to the authorizing user. However, scopes can be edited for a developer 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

Open Account

In Global Navigation, click the Admin link [1], then click the name of the account [2].

Open Developer Keys

Open Developer Keys

In Account Navigation, click the Developer Keys link.

Add Developer Key

Add Developer Key

Click the Add Developer Key button.

Enforce Scopes

Enforce Scopes

After you've completed the developer key information, click the Enforce Scopes button.

Search Endpoints

  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

  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

  Select Individual Endpoints

You can grant customized access to the developer 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

Save Key

Click the Save Key button.

You are here
Table of Contents > Integrations > How do I enable scoping for a developer key in an account?

Attachments

    Outcomes