API Tokens

This document is a guide to managing your developer access tokens.

Admins can create a developer access token to use in place of a password when authenticating with Canopy in the command line or with the API.

Developer access tokens are an alternative to passwords for authenticating with Canopythe when using the Canopy API or command line.

Developer access tokens created by the administrator are for developers to access Canopy resources. A token’s capabilities are limited to the scopes or permissions granted to it. Admins must develop tokens for each Tenant to maintain the data’s jurisdiction. A token cannot grant additional access capabilities to a user and will not give the organization administrative access.

Scope:

• login
• billing-history
• getAssignedUsersBy

Developer access tokens are like passwords and share the same inherent security risks. When using a developer access token in a script, you should store your Token as a secret and run your script.

1. Sign in as a Tenant Administrator.
2. In the upper-right corner of any page on Canopy, click Settings, and then click Tenant.
3. In the left sidebar, click API Tokens.
4. To the right of API Tokens, click on the Create New Token.

5. In the “Name” field, give your Token a descriptive name using a combination of 40 characters, including letters, digits, and special characters. Token names cannot contain spaces.

7. Select Expiration to give your Token an expiration, then choose a default option or click Custom to enter a date.

7. Optionally, you can use the “Description” field to describe the Token’s intended use.
8. Click Generate Token.
9. View or copy the new Token to your clipboard.

You can determine the last time a developer used a token and all associated events to determine if it is no longer needed.

1. Sign in as a Tenant Administrator.
2. In the upper-right corner of any page on Canopy, click Settings, and then click Tenant.
3. In the left sidebar, click API Tokens.
4. Under Developer access tokens, scroll to find the access token you want to delete.
5. View the last access date on the card to determine the last time a developer used the Token.
6. To the right of the personal access token you want to assess, click Events to see all the events associated with this Token.

You should delete a developer access token if it is no longer needed.

1. Sign in as a Tenant Administrator.
2. In the upper-right corner of any page on Canopy, click Settings, and then click Tenant.
3. In the left sidebar, click API Tokens.
4. Under Developer access tokens, scroll to find the access token you want to delete.
5. To the right of the personal access token you want to delete, click Delete.

Please refer to the Canopy Developer documentation at http:dev.canopyco.io