Mobile Verify

Verify mobile app

get

https://canvas.instructure.com

/api/v1/mobile_verify

Verifies mobile app credentials and returns OAuth client information

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Query parameters

domainstringRequired

Canvas domain to verify

Example: canvas.instructure.com

Responses

200

Verification response

application/json

authorizedbooleanOptional

resultintegerOptional

Result code (0=success, 2=unknown domain, 3=unauthorized)

base_urlstringOptional

client_idstringOptional

client_secretstringOptional

api_keystringOptional

get

/api/v1/mobile_verify

HTTPcURLJavaScriptPython

GET /api/v1/mobile_verify?domain=text HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Verification response

{
  "authorized": true,
  "result": 1,
  "base_url": "text",
  "client_id": "text",
  "client_secret": "text",
  "api_key": "text"
}

SSO redirect dummy

get

https://canvas.instructure.com

/canvas/login

Universal link OAuth2 dummy endpoint for mobile SSO

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Query parameters

codestringRequired

domainstringRequired

Responses

302

Redirect to domain

404

Invalid domain

get

/canvas/login

HTTPcURLJavaScriptPython

GET /canvas/login?code=text&domain=text HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Mobile login QR code (GET)

get

https://canvas.instructure.com

/canvas/login_png

Generates a QR code for mobile login via GET request

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Responses

200

QR code image

image/png

string · binaryOptional

401

Unauthorized

404

QR login not enabled

get

/canvas/login_png

HTTPcURLJavaScriptPython

GET /canvas/login_png HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Mobile login QR code (POST)

post

https://canvas.instructure.com

/canvas/login.png

Generates a QR code for mobile login via POST request

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Query parameters

formatstring · enumOptionalPossible values:

Responses

200

QR code generated

image/pngapplication/json

string · binaryOptional

401

Unauthorized

404

QR login not enabled

post

/canvas/login.png

HTTPcURLJavaScriptPython

POST /canvas/login.png HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Apple app site association

get

https://canvas.instructure.com

/.well-known/apple-app-site-association

Returns Apple Universal Links configuration

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Responses

200

Apple app site association JSON

application/json

objectOptional

get

/.well-known/apple-app-site-association

HTTPcURLJavaScriptPython

GET /.well-known/apple-app-site-association HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Apple app site association JSON

{}

Android asset links

get

https://canvas.instructure.com

/.well-known/assetlinks.json

Returns Android App Links configuration

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Responses

200

Android asset links JSON

application/json

object[]Optional

get

/.well-known/assetlinks.json

HTTPcURLJavaScriptPython

GET /.well-known/assetlinks.json HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Android asset links JSON

[
  {}
]