Motimate:如何使用公共 API 配置和管理用户及用户组?
通过将源系统连接到我们的 REST API,您可以在 Motimate 中配置和管理用户。 这使您能够处理 Motimate 中的几项核心工作,如创建用户、更新用户、删除用户、创建组以及将用户配置到正确的组。
有关 Motimate 公共 API 的一般信息以及如何开始使用、 请参阅此处.
背景资料
- 所有用户和群组都有自己独一无二的 Motimate ID,可与应用程序接口一起使用,但您也可以定义一个 "外部 ID",与应用程序接口一起使用。 外部 ID "通常与用户或组在数据源中的 ID 相匹配。
- 组用于创建层次结构或组树。 这通常与您的组织结构密切相关,用于授权培训和获取报告。 这通常以部门和团队或地区为基础。 我们建议在创建用户之前先创建组,这样就可以在创建后直接将用户分配到组中。 有关小组结构的更多信息,请参见此处。
- 通过用户的职位,您可以根据他们在组织中的角色分配培训任务。 有关用户职位的更多信息,请参见此处。
- 我们建议在转移到生产环境之前,先建立一个测试环境,对调用和集成进行整体测试。 请联系您的客户成功经理或support@motimateapp.com 寻求帮助。
- Motimate 的 API 采用 JSON 格式。
创建小组
要创建群组,请使用以下调用:
POST https://motimateapp.com/public_api/groups
在正文中添加有效载荷,其中包含必要的组信息。 父_id "字段用于创建组结构。 在此字段中输入不同组的 ID 将把该组设为父组。
请注意:组的级别必须比父组的级别低,"1 级 "是最高级别。 这样您就可以将组结构导入您的 Motimate 账户。
更新组
要在 Motimate 中更新组,您需要执行以下调用。 本例中使用的 id 是 Motimate 组的 id。
PATCH https://motimateapp.com/public_api/groups/{group_id}
在正文中添加有效载荷,其中包含要在群组上更新的必要数据。 当需要将组移动到不同的层级或需要调整结构时,可以使用这种方法。
删除群组
要在 Motimate 中删除组,您需要拨打以下电话。 本例中使用的 id 是 Motimate 组的 id。 将强制设置为 ´1´ 会硬性破坏记录,在这种情况下无法恢复组。
删除 https://motimateapp.com/public_api/groups/{group_id}
运行此调用将删除所选组,但不会返回响应:
创建用户
要创建用户,请使用以下调用:
发布 https://motimateapp.com/public_api/users
在正文中添加包含用户必要信息的有效载荷。 电子邮件地址或电话号码都是必填字段,具体取决于您的 Motimate 账户设置。 您可以使用组分配字段选择用户的组。 输入您希望用户加入的组 ID 及其在组中的角色(成员、管理员或观察员)。 我们建议在绝大多数情况下将 assing_ancestors 设置为 "true"。 这将确保用户成为其所分配组的父组的成员。
更新用户
要在 Motimate 中更新用户信息,您需要进行以下调用。 本例中使用的 id 是 Motimate 用户 id。
PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id
在正文中添加有效载荷,其中只包含要为用户更新的必要数据。
删除用户
要在 Motimate 中删除用户,您需要调用以下程序。 本例中使用的 id 是 Motimate 用户 id。 将强制设置为 ´1´ 会硬性破坏记录,在这种情况下无法恢复组。 将其设置为 ´0´ 将软删除记录,以便在必要时恢复。
DELETE https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id
运行此调用将删除所选用户,但不会返回响应:
恢复用户
有时用户会被误删,需要恢复。 如果是软删除,而不是硬销毁,可以通过以下调用来完成。 本例中使用的 id 是 Motimate 用户 id。
PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id
0 条评论
请登录写评论。