{ "opencollection": "1.0.0", "info": { "name": "Canvas LMS REST Accounts Users API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://canvas.instructure.com/login/oauth2/auth", "accessTokenUrl": "https://canvas.instructure.com/login/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List Users in a Course", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/courses/:course_id/users", "params": [ { "name": "course_id", "value": "", "type": "path", "description": "The Canvas course ID or an SIS course ID prefixed `sis_course_id:`." }, { "name": "enrollment_type[]", "value": "", "type": "query" }, { "name": "enrollment_role", "value": "", "type": "query" }, { "name": "include[]", "value": "", "type": "query" }, { "name": "search_term", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query", "description": "Items per page (default 10, max varies by endpoint and install)." } ] }, "docs": "List Users in a Course" }, { "info": { "name": "Get a Single User", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "include[]", "value": "", "type": "query" } ] }, "docs": "Get a Single User" }, { "info": { "name": "Get the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/users/self" }, "docs": "Get the Authenticated User" }, { "info": { "name": "Get the Authenticated User's Profile", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/users/self/profile" }, "docs": "Get the Authenticated User's Profile" } ] } ], "bundled": true }