我该如何格式化 CSV 文本文件来把 SIS 数据上传到 Canvas 帐户?

您可以利用 Canvas 管理员界面导入 CSV 文件以手动批量创建用户、帐户、学期、课程、班次、注册学生和登录凭证。

本文档引用 SIS 导入的 CSV 格式 API 的页面,处于多数 CSV 的信息里。每个 CSV 文件都与另一文件共生,并指示 Canvas 如何管理帐户的所有信息。查看 SIS 关系图

示例文件

此教程的每个步骤提供 CSV 文件的详细信息和每个必填字段和可选字段的描述。每个步骤还包含下载示例 CSV 文件用的链接。示例文件包含所有必填字段,也可能包含可选字段。此外,您还可以下载所有示例文件的压缩包。如果 CSV 链接无法提供下载,请尝试在新选项卡中打开链接。

您在把任何内容导入到您的生产环境前,应练习在 Canvas 测试环境中导入数据。

CSV 文件格式

为了批量上传数据到 Canvas,您必须创建超过一个 CSV 文本文件。CSV 文件可以通过很多程序生成。学生信息系统 (SIS) 通常有方法生成可以修改来适合 CSV 格式的报告。如果您不知道如何保存 CSV 格式的文件,请查阅您正使用来创建您的 CSV 文件的程序文档(如,Excel)

SIS 导入 (SIS Import) 页面,使用 Instructure 格式导入文件时,您可以导入单个 CSV 文本文件,或把多个文件压缩到一个 ZIP 文件内,用来批量导入数据。如果您手动地上传各个文件,文件必须显示在本教程中的顺序上传。

CSV 的栏目格式化

您的 CSV 文件(标题)的第一行包括含有每个文件的完整字段名。的顺序并不重要,但恰当顺序的对于像 accounts.csv 的文件是至关重要的。

置顶字段

默认情况下,在用户界面中做出的特定更改不会被将来的 SIS 导入覆盖,且被指定为置顶字段。本文件中的所有置顶字段均已进行标识。您可以通过在 API 中设置 override_sis_stickiness 或选中 SIS 导入 (SIS Import) 页面中的覆盖UI更改 (Override UI changes) 复选框的方式覆盖这些字段。

API 文档

CSV 文件仅包括一组特定的领域。Canvas 包含可通过每个个人的 API 附加值。在您的机构运行 CSV 文件后,大多数机构的标准做法是上传所有 SIS CSV 的文件,然后使用 Canvas API,以更新整个帐户和课程属性。想了解更多的信息,请查看用户、帐户、学期、课程、班级、注册和组群的 Canvas API 文档。还可使用 SIS 导入 API 管理 SIS 导入。

users.csv

用户是在一个机构内拥有用户帐户的人们。users.csv 把人们作为普通用户添加到系统。enrollments.csv 将给这些用户分配一个角色(教师、学生等)。当用户帐户被删除时,它们的全部注册也将被删除,而学生们将无法再登录他们的 Canvas 帐户。如果您仍然希望用户能够登录,但只是不参与,或如果您只想删除某一课程的用户,那么,您就应该让他们的用户账号设为活跃,并把他们的注册(在 enrollments.csv 文件里)分别地改为完成已删除

利用 10 个 Canvas 用户帐户下载 users.csv 文件样本。

必填字段* | 置顶字段^

  • user_id*用于识别在 Canvas 中有帐户的任何人员的唯一值。此值不能由用户更换,而且必须是唯一的超越所有用户之上。在用户界面,这就是所谓的 SIS ID,它可以由字符的任意组合而成。您可以通过访问的任何用户帐户,然后观察他们的登录信息,找到这个 SIS 的 ID。
  • integration_id:是适用于更复杂的 SIS 整合的二类唯一标识。这个标识不必由用户改变,而且必须全局地不同。
  • login_id*^是用于登录 Canvas 的用户名。如果您配置认证服务(如 LDAP),这将会与他们的远程系统中的用户名相匹配。Login_id 可以包含字母、数字或这些字符:- _ = + 。@
  • password:如果帐户配置为使用 LDAP 或 SSO 协议,则密码不是必需的。否则,密码是为 “login_id” 而设。此密码必须至少 8 个字符。
  • ssha_password:在这一栏,与其使用一个纯文字密码,不如通过未安检的密码而生成的方案使用 SSHA 密码。同时,要想一个更好的纯文字密码,您应鼓励用户在第一次登录后改变他的密码。了解更多有关如何生成 SSHA 密码的详情。
  • authentication_provider_id:这是登录账号关联的身份验证机构。与特定运营商关联的登录账号只能用于该运营商。遗留项运营商 (LDAP, CAS, SAML) 将搜索与之关联的登录账号,或未关联的登录账号。新运营商只能搜索与之明确关联的登录账号。可以是运营商的完整 ID,或运营商的类别(在此种情况下将查找第一个匹配的运营商)。
  • first_name^:是用户的名字(名)。如果存在,用于构建 full_name 和/或 sortable_name。
  • last_name^:是用户的姓氏(姓)。如果存在,用于构建 full_name 和/或 sortable_name。
  • full_name^:是用户的名字和姓氏。如果已提供,则省略 first_name 和 last_name。
  • sortable_name^:是 Canvas 中的可排序名称选项,通常是从用户姓名推理出的,但是可以自定义。
  • short_name^:是用户的显示名,通常是从用户姓名推理出的,但是可以自定义。
  • email:这是机构分配的电子邮件地址,也将标记为此用户帐户的默认电子邮件地址。即使与用户的 login_id 相同,这个电子邮件地址仍然应被提供。
  • 代词:如果启用了人称代词,这些是在 Canvas 中显示在用户姓名后面的人称代词。代词字段接受所有代词,即使它们不是在帐户设置 (Account Settings) 页面中创建的。
  • declared_user_type:此声明的用户类型可以是管理员、观察员、员工、学生、学生_其他或教师。可以通过 "<delete>" 从用户删除声明的用户类型。
  • canvas_password_notification:此字段默认为假。当为真时,如果 authentication_provider_id 为 Canvas,则通知用户设置密码。如果您的机构没有 Canvas SIS 集成,则必须填写此字段以向新用户通知其创建的帐户。
  • home_account:将 home_account 设置为真, 将会在 SIS 导入的目标帐户中创建一个新用户,并合并来自联盟内具有匹配 integration_id 的另一帐户的另一个现有用户。将被忽略,除非目标帐户与自动合并联盟相关联。
  • status*^:您可以在此处添加或删除 Canvas 中的用户。标记为主动以添加用户,或标记为暂停以暂停用户,或标记为删除以删除现有的用户。

电子邮箱地址冲突

Canvas 是按电子邮箱地址辨认用户。当学生被添加到课程,在用户的第一次登录到课程,Canvas 将尝试调解任何电子邮箱地址的冲突。

正常来说,每个学生的电子邮箱地址是不同的。有时,多个学生可能共享一个电子邮箱地址。当通过 SIS 导入添加学生到课程时,Canvas 会对多个学生分配的电子邮箱地址进行辨认。

  • 如果新的 SIS ID 与一个已经分配到存在的 SIS ID 的电子邮箱地址相关,Canvas 会发送一个电子邮件到电子邮箱地址。
  • 当用户是通过 SIS 导入添加到帐户时,他们不会收到电子邮件通知,除非系统验出重复用户。但是,如果用户被添加或手动地注册,他们会收到电子邮件通知他们被添加或注册到一个新课程。共享电子邮箱地址的学生会收到电子邮箱地址已经被使用的通知并邀请在 Canvas 中创建新帐户。这个过程也可以在添加用户到课程注册时适用。

accounts.csv

帐户是在 Canvas 内的一个组织单位(例如,一个机构的母帐户)。每个帐户可以包含一个子帐户的层次,如在一个机构内为个别院校创建帐户,或在学区内为各学校建立帐户的层次结构。子帐户也可以包含多个子帐户,比如当一个学院细分为系或专业时,或一所学校细分为年级或学科时。

利用下列子帐户下载 accounts.csv 文件样本。

  • 在您的主要/ 根帐户内的 3 个子帐户。(艺术与人文、商务、数学和科学)
  • 在您的商务子帐户内的 4 个子帐户。(会计学、计算机科学、经济学和市场营销)
  • 在您的数学与科学子帐户内的 3 个子帐户。(生物、物理、统计)
  • 在您的艺术与人文子帐户内的 1 个子帐户。(视觉艺术)
  • 在您的视觉艺术子帐户内的 2 个子帐户。(摄影和数字媒体)

必填字段* | 置顶字段^

  • account_id*:创建子帐户用的唯一标识符。该 courses.csv 文件将允许您分配给课程一个特定的帐户 ID。这独特的标识符不能为帐户更改,且必须是全局唯一的所有帐户。在 Canvas 的用户界面上,这就是所谓的 SIS-ID,它可以通过访问各子帐户的设置而被修改。
  • parent_account_id*^:该标识符表示子帐户应嵌套在该母帐户下。如果此字段为空白,则该子帐户将被嵌套在您的根或主帐户之下。请注意,即使所有值均为空白,然而列必须包含区分从一个小组导入的文件。
  • name*^:是子帐户的名称。
  • status*:是指创建或删除子帐户的方法。标记为主动来添加子帐户,或以删除移除现有的子帐户。
  • integration_id:是适用于更复杂的 SIS 整合的二类唯一标识。这个标识符不能针对帐户进行更改,并且必须是全局唯一的标识符。

terms.csv

学期提供分配给该学期的所有课程的一系列默认开始日期和结束日期。对于学期课程的开课日期可在无需导入文件的课程级别里手动管理。然而,附带的一 term_id 连接到许多不同的课程,以确保学期内的所有课程在同时开始/结束。当在管理员界面上查看数据和报告时,上传的学期日期也将帮助您安排和组织课程。

下载有 10 个学期的 terms.csv 示例文件

必填字段*|置顶字段^

  • term_id*:是学期的唯一标识符。courses.csv 文件将允许您引用 term_id 确定您的课程何时开始和何时结束。这个标识符不会因学期而改变,并且必须是所有学期的全局唯一标识。在用户界面,这就是所谓的 SIS-ID。
  • name*^:是您的学期的名称。一个好的命名惯例将帮助您轻松地查阅各学期的情况。有许多管理工具,让您按学期名称来搜索或查询数据。
  • status*:是指创建或删除学期的方法。标记为主动添加学期,或删除现有的学期。
  • start_date^:是指学期的开始日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替,如示例截图所示)。例如,2013 年 8 月 26 日,美国东部标准时间下午 5:00 应写成 2013-08-26T17:00-5:00
  • end_date^:是指学期的结束日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替,如示例截图所示)。按默认情况下,用户访问也在您的指示结束日期被中断,意味着前一天是用户的最后一个全天可以访问学期。最佳实践就是设置您的结束日期到学期结束的第二天。
  • integration_id:是适用于更复杂的 SIS 整合的二类唯一标识。这个标识符不能针对学期进行更改,并且必须是全局唯一的标识符。
  • date_override_enrollment_type:您可以利用此标识符设置或删除现有学期内特定报名类型的始末日期。一旦设置,term_id、status、start_date、end_date 除外,行将忽视所有列。如果状态设置为激活,则学期日期将只应用至特定类型的报名。如果状态设置为删除,则特定报名类别将删除当前设置的日期。报名类型可以设置为 StudentEnrollment、TeacherEnrollment、TaEnrollment、DesignerEnrollment。

courses.csv

课程是一个组织演示的有关特定主题。有时一个课程可包括一系列的课程。课程必须在学期范围内创建默认的开始和结束日期。然而,如果一门课程,包括特定的课程日期,通过 term_id(如果有的话)可确认这些日期将覆盖学生在学期内的访问日期。附加 term_id 的价值是,您在管理界面时能够整理和组织课程,查看数据和报告。一个 term_id 可以容易地连接到同时开始/结束的许多不同的课程。如果您没有把课程链接到学期,然而,课程将被链接到学期,此谓默认期限

如果您的机构启用了模板课程,您可以使用 courses.csv 把关联的课程添加到模板课程内。请注意,模板课程必须作为模板课程创建并启用,然后才能添加关联课程。

下载有 10 门课程的 courses.csv 文件样本;这些课程位于特定学期内各自的子帐户内。

必填字段*|置顶字段^

  • course_id*:是指 Canvas 内用于区分课程的唯一标识符。不能对课程更改此标识符,并且此标识符必须是所有课程的全局唯一标识。在用户界面,这就是所谓的 SIS-ID。
  • short_name*^是指课程的简称。在 Canvas 用户界面中,就被称为课程编号 (Course Code) 参考编号 (Reference Code)
  • long_name*^是指课程的长(完整)名称。(这可以与简称相同,但是如果两者都可用,能提供两者将会提供更好的用户体验。)
  • account_id^:这是 SIS ID 帐户的唯一标识符(来自 accounts.csv),该标识符描述课程将存在于哪个子帐户项下。如果没有给新课程指定 account_id,那么该课程将附加到您的主/根帐户。SIS ID 可在子帐户设置内找到。
  • term_id^:是指学期的唯一标识符(来自 terms.csv),指示课程的开始时间和结束时间。如果有一个与课程关联的 term_id,您无需输入 start_date 和 end_date。
  • status*^:这是您创建、删除、结束或发布课程的方法。标记为激活以添加课程、标记为已删除以删除现有课程、标记为已完成以结束现有课程,或标记为已发布以发布现有课程。
  • integration_id:是适用于更复杂的 SIS 整合的二类唯一标识。这个标识符不能针对课程进行更改,并且必须是全局唯一的标识符。
  • start_date^:是指课程的开始日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替)。
  • end_date^:是指课程的结束日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替)。按默认情况下,用户访问也在您的指示结束日期被中断,意味着前一天是用户的最后一个全天可以访问课程。最佳实践就是设置您的结束日期到课程结束的第二天。
  • course_format:是课程格式。格式可以是在线,、在校园,或混合
  • blueprint_course_id:这是您希望添加关联课程的模板课程的课程ID。若要删除模板课程(Blueprint Course)链接,可在ID的位置传递“取消关联”。在用户界面中,这是模板课程的SIS ID。
  • homeroom_course:这用于给 Canvas for Elementary 帐户指定本年级指导教室课程。要求启用 Canvas for Elementary 设置。

sections.csv

班级在课程内把学生细分。多个班级也可以跨列为一门课程,特别是如果所有班级的学生都学习同样的课程材料。多个班级可被放置在一个课程中,但班级不能再包含多个班级。班级承传学期为课程设置的日期。但是,如果一个班级包括具体日期,这些日期将覆盖学期课程的开始和/或结束日期,以及学生的访问日期。

如果您尝试删除一个课程和一个与用户相关的班级,您将需要在 CSV 导入的 section_id 参数,以及班级的 SIS IDs。

对下列班次下载 sections.csv 文件样本:

  • ACCT300 - 成本会计课程的 4 个班级
  • ACCT310 - 管理会计课程中的 4 个班次
  • BIO101 - 生物学入门课程中的 2 个班次

该文件假设您可以在一个课程内有多个班级。许多机构把导入课程班级作为单独课程。这可以通过 (1) 在 courses.csv 中为每个班级创建一个 Canvas 的课程来完成,然后 (2) 在这些课程中创建一个单独班级来完成。您基本上可以使用相同数据,包括 course_ID 和 section_ID 都相同的 SIS ID 的课程和班级。

必填字段*|置顶字段^

  • section_id*:是在课程中创建部分的独特标识符。这个标识符不能为部分改变,并且必须是全局唯一的标识。在用户界面,这就是所谓的 SIS-ID。
  • course_id*^这是要添加或删除班次的课程的唯一标识符(添加到 courses.csv 中)。
  • name*^:是指班次的名称。班级是按名称的字母顺序排列。
  • status*:是指在课程内创建或删除班次的方法。标记为主动来创建部分,或以删除 移除现有的部分。
  • integration_id:是适用于更复杂的 SIS 整合的二类唯一标识。这个标识符不能为部分改变,并且必须是全局唯一的标识。
  • start_date^:是指班次的开始日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替)。
  • end_date^:是指班次的结束日期。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ(T 可以用空格代替)。按默认情况下,用户访问也在您的指示结束日期被中断,意味着前一天是用户的最后一个全天可以访问班级。最佳实践就是设置您的结束日期到班级结束的第二天。

enrollments.csv

注册是一名作为特定角色报名参加课程的用户。一个 enrollments.csv 可允许您为用户分配角色,并将他们放到合适的课程。当任何用户的注册状态被标记为已完成时,在该课程里,他们将被限制为只读课程。

注意:包含 start_date 和 end_date 值的 SIS 注册 CSV 文件覆盖学期日期、课程日期和班次日期。

在下列注册课程中,下载 enrollments.csv 文件样本:

  • ACCT300 - 成本会计课程中一个教师用户。
  • ACCT300 - 成本会计课程中一个助教用户
  • ACCT300 - 成本会计课程中一个设计师用户
  • ACCT300 - 成本会计课程班级 1 有 3 个学生用户。
  • ACCT300 - 成本会计课程班级 2 有 3 个学生用户。
  • ACCT300 - 成本会计课程班次 1 中有 1 名学生用户作为观察员。

必填字段*|置顶字段^

  • course_id*:(如果 section_id 缺失,此为必填项)这是用户将注册的课程的唯一标识符(添加到 courses.csv 中)。如果不是特定的部分,而是课程招生,就要在这栏目里把 course_id 输入。否则,让它留空。
  • root_account:是用来搜索用户的帐户域名。
  • start_date^:这是注册开始日期。要使 start_date 生效,还需填充 end_date。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ。
  • end_date^:这是注册结束日期。要使 end_date 生效,还需填充 start_date。格式应为 ISO 8601:YYYY-MM-DDTHH:MM:SSZ。
  • user_id*:是指用户的唯一标识符,将注册到指定的课程内(在 users.csv 内添加)。如果存在 user_integration_id,将忽略此字段。
  • user_integration_id*:(如果 user_id 缺失,此为必填项)这是用户的第二个唯一标识符(作为 integration_id 添加到 users.csv 中)。
  • role*:是指针对指定课程分配给用户的身份。作为注册用户,您可充当以下任何角色:教师、设计师、助教、学生、观察员或您想自定义的角色。每个角色都有一个权限集。管理员可以在主/ 根帐户或子帐户的级别上进行自定义。
  • role_id*:(必要,如果角色缺失) 是作为注册一部分被添加用户的角色的独特标识。
  • section_id*:(如果 course_id 缺失,此为必填项)这是用户将注册的班次的唯一标识符(添加到 sections.csv 中)。如果在课程的特定部分招生,就要在这栏目里把 section_id 输入。否则,请将此栏目留空。如果没有指定的 section_id,课程的默认部分将被使用。如果默认部分不存在,一个部分会在无需 SIS-ID 下自动被创建。
  • status*:是指在课程的注册、结束、禁用(停用)、删除方法。标记为有效,用于把用户注册到课程内;已完成,用于取消用户在课程内的注册;停用,用于在课程内禁用用户;删除,用于从课程内删除用户。学生处在‘停用’状态时,将列在课程学生名册内供讲师浏览,但注册启用前不能查看或参加课程。
  • associated_user_id:(只适合观察员的角色),是可查看用户信息(包括成绩)观察员的独特标识符。作为用户,观察员应注册您想他们观察的同一课程/部分。此栏目将被忽略,观察员角色除外。
  • limit_section_privileges:用于说明如何把注册课程指定为只允许用户查看 course_section_id 指定的班次内注册的用户,并与之互动。该栏默认为假。限制学生仅按班次互动,这会影响协作、Chat 聊天、人员、会话。注册讲师和助教时,班次限制允许这些用户给相同班次内的学生评分。讨论话题和页面不受班次限制影响,可供任何学生查看。可以在课程小组内创建内容来限制这些功能区域。
  • 通知:这是您选择在注册用户注册课程时向其发送通知的方式。

group_categories.csv

您可以利用组类别在 Canvas 中组织组。您可以利用 group_categories.csv 在帐户级或课程级创建组类别。在用户界面,组类别称作组集合。

为下列组类别下载 group_categories.csv 文件样本:

  • 管理员组
  • 设计员组
  • 历史项目组

必填字段*|置顶字段^

  • group_category_id:是用来辨认您的组类别的标识符。这个标识符不能针对组类别进行更改,并且必须是全局唯一的标识符。
  • account_id:是附加组类别到帐户的标识符(在 accounts.csv 添加)。如果没有指定帐户或课程,小组将附加到根帐户。
  • course_id:是附加组类别到课程的标识符(在 courses.csv 添加)。如果没有指定课程或帐户,小组将附加到根帐户。
  • category_name*^是指组类别的名称。
  • status*:是指组类别的状态。标记为活跃用于创建组类别,或标记为删除用于删除组类别。

groups.csv

一个小组可被用作为学生、讲师、管理员或其他用户提供协作机会。您可以使用 groups.csv 创建课程级别小组和帐户级别小组。通过 SIS 上传的组群只可以通过 SIS 更新或删除。

为下列小组下载 groups.csv 文件样本

  • 管理员
  • 数学讲师
  • 设计者

必填字段*|置顶字段^

  • group_id*:是用来辨认您的小组的独特标识符。它必须不能改变并必须要全局地独特。
  • group_category_id:这是您要对其添加组的组类别的标识符(在 group_categories.csv 中添加)。如果未指定组类别,则组将放置到定义的帐户或课程的默认组类别中。如果指定了帐户或课程,则组将放置到根帐户默认的组类别中。
  • account_id:是附加小组到帐户的标识符(在 accounts.csv 添加)。如果没有任何指定,小组将附加到根帐户。
  • course_id:这是附加组到课程的标识符(在 courses.csv 添加)。如果没有指定课程或帐户,小组将附加到根帐户。
  • name*^:是指小组的名称。
  • status*:是指小组的状态。标记为可用,设置小组对成员开放,或以删除来删除小组。

groups_membership.csv

小组的成员允许用户在 Canvas 的活动协作。一个 groups_membership.csv 允许您批量添加或移除人员到您通过 groups.csv 创建的小组。

为下列小组成员下载 groups_membership.csv 文件样本

  • 管理员组中的一个已接受的用户
  • 数学讲师组中的一个已接受的用户
  • 数学讲师组中的一个已删除的用户

必填字段*

  • group_id*:是用来辨认您的小组的独特标识符(在 groups.csv 添加)。
  • user_id*:这是您要添加到小组的用户的唯一标识符(添加到 users.csv 中)。
  • status*:是指小组中用户的状态。标记为可用,设置小组对成员开放,或以删除来删除小组。

xlists.csv

跨列允许您将班级移动到另一门课程。一个 xlist.csv 文件允许您在现存课程跨列班级,并创建一个班级的分层结构。

班级 ids 应已存在并已列出其它的课程 ids。如果在此文件中提供了一个班级 id,它将被从现存的课程 id 移动到新的课程 id。如果那个新课程或跨列被移除,班级将返回到先前的课程 id。如果 xlist_course_id 没有列出现存的课程,它将被创建。如果您想提供更多信息有关跨列课程,请在 courses.csv 进行。

为以下课程和班级下载 xlists.csv 的样板文件

  • 4 个活跃班级从 ACCT300 - Cost Accounting 课程跨列到 ACCT310 - Managerial Accounting 课程

必填字段*

  • xlist_course_id*:是新课程的标识符(在 courses.csv 添加)。
  • section_id*:是指班次的标识符(在 sections.csv 中添加)。
  • status*:是指班次的状态。标记为活跃,使到班级活跃或以删除来移除班级。

user_observers.csv

观察员的身份可用于注册家长,并把家长链接到学生,从而允许家长查看其子女的得分以及课程互动。一个 user_observers.csv 允许您注册并链接观察员到每个学生所注册的课程。

为下列注册学生下载 user_observers.csv 文件样本

  • 2 个活跃的观察员
  • 1 个已删除的观察员

必填字段*

  • observer_id*:这是观察员的唯一标识符(作为 user_id 添加到 users.csv 中)。
  • student_id*:这是学生的唯一标识符(作为 user_id添加到 users.csv 中)。
  • status*:是指观察员的状态。标记为活跃,对每个学生的注册登记观察员或以删除来移除所有观察员的注册。

logins.csv

您可以利用 logins.csv 创建或更新用户的登录凭证。仅限给现有用户添加登录凭证。可以使用 users.csv 删除登录凭证。

下载包含三个用户登录凭证的样 logins.csv 文件本

必填字段* | 置顶字段^

  • user_id*:这是用户的唯一标识符(引用自 enrollments.csv)。此值不得对用户修改,在全体用户当中必须是唯一的。调用 Canvas 用户界面中的 SIS ID。
  • integration_id:这是适用于复杂 SIS 整合的二类唯一标识符。此值不得对用户修改,在全体用户当中必须是唯一的。把用户与匹配的集成 ID 合并时,此字段应留空。
  • login_id*:这是用户登录 Canvas 用的名称。关于配置的验证服务,例如 LDAP,这将是远程系统提供的用户名。
  • password:这是用户登录 Canvas 用的密码。配置为 LDAP 或 SSO 的帐户不得填写此字段。
  • ssha_password:这是利用预散列 SSHA 生成方案生成的密码。
  • authentication_provider_id:这是登录帐户关联的身份验证提供程序。
  • existing_user_id^:这是用户 SIS ID,可在 users.csv 中找到。
  • existing_integration_id^:这是用户的集成ID,可在 users.csv 中找到。
  • existing_canvas_user_id^:这是用户的 Canvas ID。
  • root_account:这是用户的域名帐户。
  • email:这是用户的电子邮件地址。

注意:

  • 必须提供一个 existing_user_id,existing_integration_id 或 existing_canvas_user_id,才能成功导入 logins.csv。
  • 标识信任帐户中的用户时(例如,在信任帐户中跨帐户跨列用户时),root_account 字段是必填字段。

admins.csv

管理员管理整个帐户或子帐户的设置。admins.csv 允许您把 Canvas 内的用户指定为帐户管理员或其他自定义帐户身份或子帐户身份。

为下列管理员下载 admins.csv 文件样本

  • 2 个有效的帐户管理员
  • 1 个删除的帐户管理员
  • 2 个有效的自定义帐户身份

必填字段*

  • user_id*:这是您要指定为管理员的用户的唯一标识符(添加到 users.csv 中)。
  • account_id*:这是您要管理员驻留的帐户的唯一标识符(添加到 accounts.csv 中)。如果栏目留空,用户将驻留在根帐户内。即使值是空白的,该栏目仍始终是必填项。
  • role_id*:(角色缺失时须此标识符)这是角色的 ID,是默认 ID 或帐户定义的自定义 ID。
  • role*:(role_id 缺失时须此标识符)这是角色的名称,是默认的帐户管理员角色或帐户定义的自定义角色。如果您正在添加帐户管理员,请把字段格式设置为读取 'AccountAdmin’。如果您正在添加自定义角色,请按照字段在 Canvas 用户界面中的样式准确定义其格式。
  • status*:是指管理员的状态。标记为有效来创建有效的管理员,或标记为删除来删除管理员。
  • root_account:是用来搜索用户的帐户域名。

change_sis_id.csv

SIS ID 是 Canvas 中的对象的唯一标识符。Change_sis_id.csv 允许您为现有的帐户、学期、课程、班次、小组或用户批量更改 SIS ID。

为下列 SIS ID 变更下载 change_sis_id.csv 文件样本

  • 更改 1 个用户 SIS ID
  • 更改 1 个课程 SIS ID
  • 更改 1 个学期 SIS ID

必填字段*

  • old_id*:这是对象当前的 SIS ID。
  • new_id*:是对象需要的 SIS ID。新 SIS ID 目前必须是对象类型和根帐户的唯一标识符。
  • type*:是对象的类型。类型可以是帐户、学期、课程、班次、小组或用户。