Types [Application]

A CanvasTools Application that can be registered through the API.

Properties

---

• name: String The name of the application.
• owner: String The plain text name of the owner of the application.
• homepageURL: String The URL of your application.
• description: String A description of what the application does.
• site: String Partial URL of the site that called the register function.
• details: String We recommend using this field to explain to the user why you need to have account access.
• token: The access token you can use with the Canvas API. Token can be appended to all Canvas API requests (https://canvas.instructure.com/api/v1/courses?access_token=)
• tokenID: String The ID of the token, this is required for future CanvasTools API calls. We recommend storing it in your database or in cookies.
• tokenName: String The name of the token that will show up in Canvas settings.
• userID: String The ID of the Canvas LMS user. This will be needed to perform any actions on the user.
• canvasDomain: String Needed for all API calls, this is the domain you call from. (https://canvas.instructure.com)
• content: String Optional HTML you want to display in the application content area. You can use this to provide details on the status of your application, the user's information, etc.
• buttons: Array Optional An array of buttons your application will contain.
• button: Object An object that goes inside the buttons array.
• button.name: String The name of the button that will be displayed to the user.
• button.link: String The URL the button will navigate to when clicked.