Canvas

Canvas Discovery Pages API

The Discovery Pages API from Canvas — 2 operation(s) for discovery pages.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/discovery_pages Get the login discovery page settings · Get Discovery Page #
Ask an LLM
“What sign-in buttons does our login discovery page show?”
“Is the discovery page active for our root account?”
Tell an agent
Show the discovery page configuration.
Get the current login discovery page buttons and labels.
PUT /v1/discovery_pages Replace the login discovery page settings · Update Discovery Page #
Ask an LLM
“How do I change which identity providers appear on the login discovery page?”
“Does updating the discovery page replace the whole configuration?”
Tell an agent
Set the discovery page primary button to provider {primary} labeled {primary_label}, secondary {secondary} labeled {secondary_label}.
Turn the discovery page active setting to {active}, primary {primary} as {primary_label}, secondary {secondary} as {secondary_label}.
POST /v1/discovery_pages/token Get a discovery page preview token · Generate Discovery Page Preview Token #
Ask an LLM
“Can I preview a discovery page layout before saving it?”
“How long is a discovery page preview token valid?”
Tell an agent
Generate a preview token for a discovery page with primary provider {primary}.
Create a preview JWT for primary {primary} labeled {primary_label}.

Documentation

📖
Documentation
https://canvas.instructure.com/doc/api/
📖
Authentication
https://canvas.instructure.com/doc/api/file.oauth.html
📖
APIReference
https://canvas.instructure.com/doc/api/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/rate-limits/canvas-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-discovery-pages-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/instructure/canvas-lms

Other Resources

🔗
Pagination
https://canvas.instructure.com/doc/api/file.pagination.html
🔗
Swagger
https://canvas.instructure.com/doc/api/api-docs.json
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/scopes/canvas-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/errors/canvas-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/data-model/canvas-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas:canvas-discovery-pages-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

canvas-discovery-pages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas LMS REST Discovery Pages API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Discovery Pages
  x-resource: discovery_pages
  externalDocs:
    url: https://canvas.instructure.com/doc/api/discovery_pages.html
paths:
  /v1/discovery_pages:
    get:
      tags:
      - Discovery Pages
      operationId: get_discovery_page
      summary: Get Discovery Page
      description: 'Get the discovery page configuration for the domain root account.


        Returns labels exactly as stored, with no HTML-escaping applied.

        Callers are responsible for escaping on render (the admin React UI

        does this via JSX auto-escaping).'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryPage'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/discovery_pages.html
    put:
      tags:
      - Discovery Pages
      operationId: update_discovery_page
      summary: Update Discovery Page
      description: 'Update or create the discovery page configuration for the domain root account.

        This is a full replacement - provide the complete configuration including

        primary, secondary, and active fields. Any fields omitted will be removed.'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                discovery_page[primary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[primary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[primary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[secondary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[secondary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[secondary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[active]:
                  type: boolean
                  description: Whether the discovery page is enabled. Defaults to false if not provided.
              required:
              - discovery_page[primary][authentication_provider_id]
              - discovery_page[primary][label]
              - discovery_page[secondary][authentication_provider_id]
              - discovery_page[secondary][label]
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                discovery_page[primary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[primary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[primary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[secondary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[secondary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[secondary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[active]:
                  type: boolean
                  description: Whether the discovery page is enabled. Defaults to false if not provided.
              required:
              - discovery_page[primary][authentication_provider_id]
              - discovery_page[primary][label]
              - discovery_page[secondary][authentication_provider_id]
              - discovery_page[secondary][label]
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryPage'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/discovery_pages.html
  /v1/discovery_pages/token:
    post:
      tags:
      - Discovery Pages
      operationId: generate_discovery_page_preview_token
      summary: Generate Discovery Page Preview Token
      description: 'Returns a short-lived RS256-signed JWT containing the discovery page

        button link configuration, suitable for sending to the identity service

        preview iframe via postMessage.


        A discovery_page configuration must be provided in the request body.

        Omitting it returns a 400 Bad Request.'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                discovery_page[primary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[primary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[primary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[secondary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[secondary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[secondary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
              required:
              - discovery_page[primary][authentication_provider_id]
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                discovery_page[primary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[primary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[primary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
                discovery_page[secondary][authentication_provider_id]:
                  type: array
                  items:
                    type: integer
                  description: The ID of an active authentication provider for this account.
                discovery_page[secondary][label]:
                  type: array
                  items:
                    type: string
                  description: The display label for this authentication provider button.
                discovery_page[secondary][icon]:
                  type: array
                  items:
                    type: string
                  description: Icon key for this authentication provider button.
              required:
              - discovery_page[primary][authentication_provider_id]
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                x-canvas-declared-type: '{ "token": "eyJ..." }'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/discovery_pages.html
components:
  schemas:
    DiscoveryPageEntry:
      type: object
      properties:
        authentication_provider_id:
          type: integer
          example: 1
          description: The ID of the authentication provider
        label:
          type: string
          example: Students
          description: The display label for this provider button
        icon:
          type: string
          example: google
          description: Icon key for this provider button
          enum:
          - apple
          - auth0
          - classlink
          - default
          - facebook
          - github
          - google
          - linkedin
          - microsoft
          - okta
          - onelogin
          - ping
      description: A single authentication provider entry on the discovery page
    DiscoveryPage:
      type: object
      properties:
        primary:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryPageEntry'
          description: Primary authentication provider buttons displayed prominently
        secondary:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryPageEntry'
          description: Secondary authentication provider buttons displayed less prominently
        active:
          type: boolean
          description: Whether the discovery page is enabled
      description: Configuration for the login discovery page
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Canvas OAuth2 access token sent as "Authorization: Bearer <token>". See https://canvas.instructure.com/doc/api/file.oauth.html'
    oauth2:
      type: oauth2
      description: Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauth_endpoints.html
      flows:
        authorizationCode:
          authorizationUrl: https://canvas.instructure.com/login/oauth2/auth
          tokenUrl: https://canvas.instructure.com/login/oauth2/token
          refreshUrl: https://canvas.instructure.com/login/oauth2/token
          scopes: {}
externalDocs:
  description: Canvas LMS REST API Documentation
  url: https://canvas.instructure.com/doc/api/
x-generated-from: https://canvas.instructure.com/doc/api/api-docs.json
x-provenance:
  method: derived
  derived_by: API Evangelist enrichment pipeline (Swagger 1.2 -> OpenAPI 3.1 conversion)
  source: openapi/_original/swagger-1.2/*.json (144 verbatim first-party Swagger 1.2 documents)
  source_url: https://canvas.instructure.com/doc/api/api-docs.json
  fetched: '2026-09-05'
  http_status: 200