通过


调用 Microsoft 365 API 以传输基于 API 的导入的组织数据 (步骤 2(共 3 个) (预览)

重要

此功能仅适用于公共预览版客户。 预览版中的功能可能不完整,并且可能会在更广的版本中推出之前进行更改。

适用于:Microsoft 365 全局管理员或组织数据源管理员或人力资源信息系统管理员

1. 以设定的频率准备和导出数据

导出公司中所有员工的组织数据,并将要导入的所有字段添加到 .csv 模板或外部源(如 Workday 报表即服务 (RaaS) )中的自动 .csv 输出。 了解如何构造此数据文件

你决定 ((例如每月一次或每周一次) )的频率,让自定义应用或外部源集成从源系统导出组织数据。

2. 调用 API 以导入数据

若要将数据导入 Microsoft 365,可以从以下五个选项中选择一种:

  1. 使用我们的 API 生成一个自定义应用,以你选择的频率导出和导入数据。 了解如何操作

  2. 在基于 API 的主机上运行我们的 C# 解决方案。 了解如何操作

  3. 运行 PowerShell 脚本,该脚本也基于我们的 API。 了解如何操作

  4. 使用Azure 数据工厂模板将数据发送到基于 API 的导入。 了解如何操作

  5. 运行 Node 脚本以检索 OAuth 令牌。 然后,使用这些令牌将数据从外部源(如 Workday)直接发送到基于 API 的导入。 了解如何操作

注意

我们的 C# 和 PowerShell 解决方案仅将数据导入 Microsoft 365 中的组织数据。 它们不会从源系统导出数据。

如果使用选项 1、2、3 或 4,请确保拥有此信息:

  • 应用 (客户端) ID。 在“应用程序 (客户端) ID”下的Microsoft Entra 管理中心的已注册应用信息中找到此 ID。

  • 客户端密码:这是应用程序在请求令牌时用于证明其身份的机密字符串。 它也称为应用程序密码。 此机密仅在首次创建客户端密码时显示。 若要创建新的客户端密码, 请执行以下步骤

  • 证书名称。 此名称是在已注册的应用程序中配置的。 上传证书后,证书名称将显示在Azure门户中的“说明”下。 可以使用证书名称作为客户端密码的替代方法。

  • Microsoft Entra租户 ID。 可以在应用的概述页上的 “目录 (租户) ID”下找到此 ID。

  • 缩放单元:为租户提供的缩放单元,例如“novaprdwus2-01”。

  • .csv 文件和 .csv 文件的路径。

或者,如果使用的是 选项 5,请确保拥有此信息:

  • 应用 (客户端) ID。 在“应用程序 (客户端) ID”下的Microsoft 365 管理中心的已注册应用信息中找到此 ID。

  • 客户端密码:这是应用程序在请求令牌时用于证明其身份的机密字符串。 它也称为应用程序密码。 此机密仅在创建客户端密码时显示。 了解如何创建新的客户端密码

  • Microsoft Entra租户 ID。 可以在应用的概述页上的 “目录 (租户) ID”下找到此 ID。

  • 连接器 ID:这是在Microsoft 365 管理中心中选择基于 API 的连接器时,URL 末尾显示的字符串,例如 https://admin.cloud.microsoft/OrganizationalDataInM365/connection-details/[Connector ID here]

  • 缩放单元:为租户提供的缩放单元,例如“novaprdwus2-01”。

推送数据

用于调用 Microsoft 365 API 以推送内容的应用

[POST] https://api.orginsights.viva.office.com/v1.0/tenants/{tenantid}/modis/connectors/HR/ingestions/fileIngestion

如果未设置连接器:

403: Forbidden

如果已设置连接器,但以前的引入尚未完成:

400: Bad request: Previous ingestion is not complete.

选项 1:使用 Microsoft 365 API 生成自定义导入/导出应用

可以使用 Microsoft 365 API 生成自定义应用,该应用会自动从源系统导出数据,然后将其导入Microsoft 365 管理中心。

你的应用可以采用任何形式(如 PowerShell 脚本),但它需要以选取的频率将源数据导出为 .csv 文件,并将该文件导入Microsoft 365 个应用和服务。

选项 2:通过自定义应用导出数据后,通过 C# 解决方案导入数据

以所选的频率将源数据导出为 .csv 文件后,可以在主机上运行描述性数据UploadApp C# 解决方案。 然后,描述性数据UploadApp C# 解决方案会将本地存储的数据引入 Microsoft 365。 在 GitHub 上了解详细信息

若要运行解决方案,请执行以下操作:

  1. 通过在命令行中运行以下命令将此应用克隆到计算机:

    git clone https://github.com/microsoft/orgdata_apibasedimport.git.

  2. 包含以下控制台值。

    • AppID/ClientID
    • .csv 文件的绝对路径。 设置路径的格式,如下所示: C:\\Users\\JaneDoe\\OneDrive - Microsoft\\Desktop\\info.csv
    • Microsoft Entra租户 ID
    • 证书名称

选项 3:通过自定义应用导出数据后运行描述性数据Upload PowerShell 解决方案

与选项 2 类似,以所选频率将源数据导出为 .csv 文件后,可以在主机上运行描述性数据Upload PowerShell 解决方案。 然后,描述性数据Upload PowerShell 解决方案会将本地存储的数据引入 Microsoft 365。 在 GitHub 上了解详细信息

  1. 通过在命令行中运行以下命令,将源代码克隆到计算机:

    git clone https://github.com/microsoft/orgdata_apibasedimport.git.

  2. 以管理员角色打开新的 PowerShell 窗口。

  3. 在 PowerShell 窗口中运行以下命令:

    Install-Module -Name MSAL.PS

    或者,转到此 PowerShell 库链接 以获取有关安装的说明。

  4. 设置参数。

    • ClientID
    • pathTocsvFile
    • TenantId
    • novaScaleUnit
    • ingressDataType: HR
    • ClientSecretcertificateName