How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canvas

Canvas Roles API

The Roles API from Canvas — 6 operation(s) for roles.

Documentation Provider Profile APIs.io OpenAPI GitHub

Canvas Roles API is one of 145 APIs that Canvas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a GitHub repository, an API reference, and rate-limit docs.

This API exposes 9 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://canvas.instructure.com/api, https://{canvas_host}/api.

9 operations 6 paths 3 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://canvas.instructure.com/api/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
Instructure Canvas
License
AGPL-3.0
Resource Areas
1

Authentication & Security 2

Canvas Roles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • bearerAuth — Canvas OAuth2 access token sent as "Authorization: Bearer ". See https://canvas.instructure.com/doc/api/file.oauth.html
  • oauth2 — Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauthendpoints.html

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Roles 9
GET
/v1/accounts/{account_id}/roles
List roles
list_roles 3 params → 200
POST
/v1/accounts/{account_id}/roles
Create a new role
create_new_role 1 param body → 200
GET
/v1/accounts/{account_id}/roles/{id}
Get a single role
get_single_role 4 params → 200
DELETE
/v1/accounts/{account_id}/roles/{id}
Deactivate a role
deactivate_role 4 params → 200
PUT
/v1/accounts/{account_id}/roles/{id}
Update a role
update_role 2 params body → 200
POST
/v1/accounts/{account_id}/roles/{id}/activate
Activate a role
activate_role 2 params body → 200
GET
/v1/accounts/{account_id}/roles/permissions
List assignable permissions
list_assignable_permissions 2 params → 200
GET
/v1/permissions/{context_type}/{permission}/help
Get help text for permissions
get_help_text_for_permissions 2 params → 200
GET
/v1/permissions/groups
Retrieve permission groups
retrieve_permission_groups → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Role (10 properties), Permission (6 properties), PermissionHelpText (2 properties). Each schema is shown below with its type and property counts.

PermissionHelpText
object
Information about a permission, including its purpose and considerations for use.
2 properties
Role
object
10 properties
Permission
object
A permission that can be granted to a role
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canvas-roles-api-openapi.yml Raw ↑

Other APIs Canvas publishes across the network.

Canvas LMS GraphQL API
AE Profile APIs.io
Canvas LTI Integrations
AE Profile APIs.io
Canvas Courses API
AE Profile APIs.io
Canvas Access Tokens API
AE Profile APIs.io
Canvas Accessibility Course Scans API
AE Profile APIs.io
Canvas Accessibility Course Statistics API
AE Profile APIs.io
Canvas Account Calendars API
AE Profile APIs.io
Canvas Account Domain Lookups API
AE Profile APIs.io
Canvas Account Notifications API
AE Profile APIs.io
Canvas Account Reports API
AE Profile APIs.io
Canvas Accounts API
AE Profile APIs.io
Canvas Accounts (Lti) API
AE Profile APIs.io
#Roles
← Back to C APIs
API Details
ID
canvas:canvas-roles-api
Base URL
https://canvas.instructure.com/api/v1
Docs
https://canvas.instructure.com/doc/api/
Provider
Canvas
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=canvas-roles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canvas-roles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Canvas Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.