Canvas API-使用sis_user_id

时间:2019-07-02 18:36:00

标签: canvas canvas-lms

我正在尝试通过Canvas API更新现有的用户登录。我看到文档说明您可以使用内部登录ID(这是一个数字值)更新用户登录:https://canvas.instructure.com/doc/api/logins.html#method.pseudonyms.update

但是,我想知道是否存在一种使用sis_user_id或sis_login_id(而不是内部数字登录ID)更新用户登录的方法。因此,例如,API调用类似于

PUT /api/v1/accounts/:account_id/logins/sis_user_id:firstlast123

1 个答案:

答案 0 :(得分:1)

我认为您的API调用可以完成您要尝试的操作,请查看https://canvas.instructure.com/doc/api/file.object_ids.html

  

在整个API中,对象由内部ID引用。您还可以通过在SIS ID前面加上SIS字段的名称来按SIS ID引用对象,例如sis_course_id:。例如,要检索SIS ID为A1234的课程的作业列表:

     

/api/v1/courses/sis_course_id:A1234/assignments

     

以下对象在API中支持SIS ID:

     
      
  • sis_account_id
  •   
  • sis_course_id
  •   
  • sis_group_id
  •   
  • sis_group_category_id
  •   
  • sis_integration_id(针对用户)
  •   
  • sis_login_id
  •   
  • sis_section_id
  •   
  • sis_term_id
  •   
  • sis_user_id
  •   
     

此外,某些对象支持特殊ID:

     
      
  • 用户支持self表示当前用户。
  •   
  • 帐户支持self表示当前域的根帐户,default表示默认帐户,site_admin表示站点管理员帐户。
  •   
  • 术语支持default表示默认术语,而current表示根据术语日期当前有效的术语。术语必须具有开始日期或结束日期才能被视为当前术语。如果有多个处于活动状态的术语,那么将找不到当前术语。
  •