Dsr Requests

Create DSR request

post

https://canvas.instructure.com

/api/v1/accounts/{account_id}/users/{user_id}/dsr_request

Creates a Data Subject Request for a user (GDPR compliance)

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

user_idintegerRequired

Body

application/json

request_namestringRequired

Name for the DSR request

request_outputstring · enumRequired

Output format

Possible values:

Responses

201

DSR request created

400

Missing required parameters

401

Unauthorized

post

/api/v1/accounts/{account_id}/users/{user_id}/dsr_request

HTTPcURLJavaScriptPython

POST /api/v1/accounts/{account_id}/users/{user_id}/dsr_request HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "request_name": "text",
  "request_output": "xlsx"
}

No content

Get latest DSR request

get

https://canvas.instructure.com

/api/v1/accounts/{account_id}/users/{user_id}/dsr_request

Retrieves the latest DSR request for a user

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

user_idintegerRequired

Responses

200

DSR request found

application/json

progress_statusstringOptional

request_namestringOptional

204

No DSR request found

401

Unauthorized

get

/api/v1/accounts/{account_id}/users/{user_id}/dsr_request

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{account_id}/users/{user_id}/dsr_request HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "progress_status": "text",
  "request_name": "text"
}

Download DSR request

get

https://canvas.instructure.com

/accounts/{account_id}/dsr_requests/{dsr_request_id}/download

Downloads the completed DSR request file

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

dsr_request_idintegerRequired

Responses

200

File download

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string · binaryOptional

404

Request not found or file not available

get

/accounts/{account_id}/dsr_requests/{dsr_request_id}/download

HTTPcURLJavaScriptPython

GET /accounts/{account_id}/dsr_requests/{dsr_request_id}/download HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary