基本概况
什么是一般概要文件源?
在交互中有两个与外部源的用户数据同步相关的服务:
- UMI连接器服务:使用预定义的连接器来查询特定的源(例如Azure Active Directory),并以特殊结构的XML文件的形式创建导入数据。
- UMI处理器服务:处理上述结构的文件,并将User信息导入到交互中。
在某些情况下,客户可能不能或不雷竞技rat希望使用任何预定义的连接器作为其用户数据的源。因此,他们能够定义一个通用概要文件源,使客户能够提供他们自己的XML文件用于导入。如果文件结构正确,并被传递到基础结构中的正确位置,Umi Processor Service将处理该文件,并导入用户数据。
通用概要源代码促进了这种方法。因此,客户可以将来自外部系统(如ADP、Okta、iTrent、Peoplesoft)甚至Excel电子表格的数据组装成有效的XML文件。
它是如何工作的?
- 客户在交互中创建一个通用概要文件源来处理流程。这将生成一个将在步骤3中使用的API端点。
- 客户开发一种方法来生成包含符合的用户数据的XML文件模式.这可以是他们自己的应用程序、PowerShell脚本或任何其他可以从预期的源创建XML文件的方法。
- 然后将完成的XML发送到正确的API端点。然后,Umi处理器服务将处理XML数据。
一般概要文件源演练
步骤1。创建一个通用概要文件源
要创建一个通用概要文件源,请以高级用户身份登录交互并导航到应用设置>人员管理>配置文件源管理>其他源.如果您还没有该站点的“高级用户”配置文件,请与组织的内部网管理员一起进行设置。
新的Source需要两个字段:
- 的名字
- 授权令牌
名称应该是一个唯一的名称,以识别来源。属性的“domain”属性中引用syncoptions
元素。
当使用API时,授权令牌将用于验证传入的源数据文件。
请注意
传入文件中定义的同步选项将具有优先级。如果这些是未定义的,那么可以通过Profile Options选项卡定制源。
这可以为传入用户定义默认的部门、位置和公司:
下拉列表将填充来自交互实例的数据。
Source包含用于处理Disabled和Missing用户的操作定义
对于这两种情况,选项是禁用和归档用户,或者仅禁用用户。
Source详细说明了部分数据是否与现有数据库同步。
每个复选框设置都控制处理器是否尝试同步该类型的数据
步骤2。生成用户配置文件数据
只要文件的结构符合所需的定义,UMI Processor Service可以处理任何XML文件,而不考虑源文件。有关生成有效文件的更多文档,请参阅以下页面:
- 的XSD模式是一个完整文档化的XML模式,详细描述了包含User配置文件的有效文件中所需的元素和属性(必需的和可选的)。
- 的XML文件样本文件包含示例用户和组数据,以帮助可视化处理程序期望如何查看文件。
- 指南从Excel电子表格生成XML文件提供了一个示例PowerShell脚本,可以自定义从标准Excel电子表格生成并上传/发布有效文件。
步骤3。将数据发布到API端点
在交互中创建源后,可以使用API端点发布用户概要数据。这将被传递到交互结构中适当的Drop区域。
端点格式:端点具有该格式https:// {{your_intranet_url}} / api / umi / N /上传其中“N”是源的唯一Id(源/Ldap Id)。保存Profile Source时,会显示API Url后缀,以协助构造API Url。
示例脚本
传输文件的示例脚本如下所示:
$endpoint = "https://{{intranet_url}}/api/umi/{{source_id}}/upload" $xmlPath = "C:\{{path_to_XML}}" $authToken = "{{auth_token}}" Invoke-RestMethod -Uri $endpoint -Method Post -InFile $xmlPath -ContentType "multipart/form-data" -Headers @{'X-ApiKey'= $authToken;}
curl——request POST "https://{{your_intranet_url}}/api/umi/{{source_id}}/upload" \——header "X-ApiKey: {{your_profile_source_auth_token}}" \——header "Content-Type: application/xml" \——data-binary "@{{XML_filepath}}"
请注意
提供给X-ApiKey头的值是在创建Profile Source期间在“授权令牌”字段中输入的值步骤1.
安全注意
API请求使用HTTPS,因此在传输过程中提供安全加密。
API端点的调用可以是最适合客户的,无论是通过示例中的PowerShell脚本,还是通过另一个应用程序。当到达端点时,附加到请求的XML文件在传输到Drop区域时根据模式进行验证。回复将详细说明在此过程中发现的任何问题。
一旦XML数据被传递到API端点,它将被Umi处理器服务处理。生成的日志文件和归档的数据文件将可以通过接口从Profile Sources列表中访问。
更新 大约两年前
查看可用于从AD或Excel电子表格生成有效XML文件的示例脚本。
此外,请查看Schema和Sample XML文件,以获得有关有效格式的许多问题的答案。