Canvas GuidesCanvas Admin Guide APIHow do I obtain an API access token for an account?

How do I obtain an API access token for an account?

Canvas allows for programmatic access to some pieces of information via the Canvas API. API calls require authorization and are made on behalf of an authorized user.

You can see the most up-to-date Canvas API documentation, which may or may not be accurate for locally installed instances of Canvas. If you are not using Canvas Cloud, talk to your site administrator about getting an accurate set of API documentation. Documentation can be generated by running rake doc:api on the console.

Once you have a Canvas login you can create one of these access tokens to use for testing your development projects. This token must be included as a URL query parameter in any API calls made to Canvas.

Canvas tokens align with Canvas permissions. If your Canvas account is deleted or if you are no longer an administrator, your tokens will also be revoked.

Note: API access tokens can only be removed in a user's settings page. Users with masquerading privileges cannot remove the token on behalf of the user.

Open User Settings

Open User Settings

In Global Navigation, click the Account link [1], then click the Settings link [2].

Add New Access Token

Add New Access Token

Locate Approved Integrations and click the Add New Access Token button.

Enter Token Information

Enter Token Information

Enter the purpose for the token in the purpose field [1]. Set the expiration date for the token by clicking the Calendar icon [2]. If there is no expiration for the token, leave the expires field blank. Click the Generate Token button [3].

Copy Token

Copy Token

Copy the token given to you [1]. To regenerate a new token, click the Regenerate Token button [2]. To close the window, click the X icon [3].

Note: You are only given the access token once. If you do not copy it down, you will need to create a new token.

View Approved Integrations

View Approved Integrations

View the approved integrations. You can remove the integration by clicking the Delete icon.