Azure AD (Entra ID)

借助 Azure AD (Entra ID) 连接器,您可以对 Azure Active Directory 执行插入、删除、更新和读取操作。

准备工作

在使用 Azure AD (Entra ID) 连接器之前,请先完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 确保已设置网络连接。如需了解网络模式,请参阅网络连接。
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。连接器和服务账号必须属于同一项目。如需了解详情,请参阅创建服务账号。

    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务。

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

  • 在创建 Azure AD (Entra ID) 连接之前,请在 Azure 门户/Microsoft Entra ID 中创建应用。如需了解详情,请参阅快速入门:向 Microsoft Identity Platform 注册应用和在 Microsoft Entra ID 中注册客户端应用。

配置连接器

一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下操作:

  1. 在 Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 在位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

      连接器支持的区域包括:

      如需查看所有受支持区域的列表,请参阅位置。

    2. 点击下一步。
  4. 在连接详情部分中,完成以下操作:
    1. 连接器:从可用连接器的下拉列表中选择 Azure AD (Entra ID)。
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中,输入连接实例的名称。

      连接名称必须符合以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. (可选)输入连接实例的说明。
    5. 服务账号:选择具有所需角色的服务账号。
    6. (可选)配置连接节点设置:

      • 节点数下限:输入连接节点数下限。
      • 节点数上限:输入连接节点数上限。

      节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。

    7. 如需使用该连接进行事件订阅,请选择启用事件订阅。选择此选项后,系统会显示以下选项:
      • 启用包含实体和操作的事件订阅:选择此选项可将连接用于事件订阅和连接器操作(实体和操作)。
      • 仅启用事件订阅:选择此选项可仅将连接用于事件订阅。如果您选择此选项,请点击下一步,然后配置事件订阅。
    8. Azure 租户:用于访问数据的 Microsoft Online 租户。如果未指定,则使用默认租户。
    9. 为用户提取扩展属性:确定是否提取扩展属性。
    10. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    11. 点击下一步。
  5. 在身份验证部分中,输入身份验证详细信息。
    1. 选择身份验证类型,然后输入相关详细信息。

      Azure AD (Entra ID) 连接支持以下身份验证类型:

      • Azure AD(授权代码授权类型)
      • OAuth 2.0 客户端凭据
      • OAuth 2.0 客户端凭据(包含 JWT 不记名令牌)
    2. 如需了解如何配置这些身份验证类型,请参阅配置身份验证。

    3. 点击下一步。
  6. 查看:查看您的连接和身份验证详细信息。
  7. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • Azure AD(授权代码授予类型)
    • 客户端 ID:请求访问令牌时所用的客户端 ID。
    • 范围:所需的逗号分隔列表。
    • 客户端密钥:请求访问令牌时所用的客户端密钥。
    • 密钥版本:客户端密钥的版本。
    • 授权网址:您在创建 OAuth 客户端时生成的授权网址。 输入网址,格式如下:https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent。 例如 https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent。
  • OAuth 2.0 客户端凭据
    • 客户端 ID:Azure AD (Entra ID) 为您创建的应用提供的客户端 ID。
    • 客户端密钥:包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
    • 密钥版本:客户端密钥的版本。
  • OAuth 2.0 客户端凭据与 JWT 不记名
    • 私钥:包含 PEM 格式的私钥文件内容的 Secret Manager 密文。私钥必须与公钥/证书相匹配。
    • 私钥密码:包含私钥文件的密码(短语)的 Secret Manager 密文。
    • 密钥版本:私钥 Secret 的版本。
    • 客户端 ID:请求访问令牌时所用的客户端 ID。

连接配置示例

本部分列出了创建 Azure AD (Entra ID) 连接时配置的各个字段的示例值。

Azure AD(身份验证代码授权类型)连接类型

字段名称 详细信息
位置 europe-west1
连接器 Azure AD (Entra ID)
连接器版本 1
连接名称 azure-ad-connection
启用 Cloud Logging 是
服务账号 XXXX@serviceaccount
Azure 租户 9b25e811-f983-4982-82e4-263c1ca48112
节点数下限 2
节点数上限 50
身份验证 是
Azure AD 是
客户端 ID XXXX
范围 https://graph.microsoft.com/user.read
客户端密钥 XXXX
Secret 版本 1
授权网址 https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent
在为“范围”字段指定值之前,请确保满足以下条件:
  • 您必须在连接级和 Azure 应用级提供 User.Read.All 和 User.Write.All 权限。
  • 您可以根据自己的需求,在 Azure AD 应用注册级层和连接级层添加其余范围。
  • 确保在应用级别添加委托权限和应用权限。以下范围是常用的范围:
    • https://graph.microsoft.com/group.readwrite.all
    • https://graph.microsoft.com/groupmember.readwrite.all
    • https://graph.microsoft.com/user.read.all
    • https://graph.microsoft.com/user.read
    • https://graph.microsoft.com/directory.readwrite.all
    • https://graph.microsoft.com/RoleManagement.ReadWrite.Directory
    • https://graph.microsoft.com/directory.accessasuser.all
    • https://graph.microsoft.com/domain.readwrite.all
    • https://graph.microsoft.com/device.read.all
    • https://graph.microsoft.com/RoleManagement.Read.Directory
    • https://graph.microsoft.com/organization.Read.all
    • https://graph.microsoft.com/Application.ReadWrite.all
    • https://graph.microsoft.com/AuditLog.Read.All
    • https://graph.microsoft.com/DeviceLocalCredential.Read.All.

OAuth 2.0 客户端凭据连接类型

字段名称 详细信息
位置 us-central1
连接器 Azure AD (Entra ID)
连接器版本 1
连接名称 azure-ad-client-credentials
启用 Cloud Logging 是
服务账号 XXXX@serviceaccount
Azure 租户 9b25e811-f983-4982-82e4-263c1ca48112
节点数下限 2
节点数上限 50
身份验证 是
OAuth 2.0 - 客户端凭据(含客户端密钥) 是
客户端 ID XXXX
客户端密钥 XXXX
Secret 版本 1

OAuth 2.0 客户端凭据(包含 JWT 不记名令牌)连接类型

字段名称 详细信息
位置 europe-west1
连接器 Azure AD (Entra ID)
连接器版本 1
连接名称 azure-jwt
启用 Cloud Logging 是
服务账号 XXXX@serviceaccount
Azure 租户 9b25e811-f983-4982-82e4-263c1ca48112
节点数下限 2
节点数上限 50
身份验证 是
OAuth 2.0 - 包含 JWT 不记名令牌的客户端凭据 是
私钥 XXXX
Secret 版本 1
客户端 ID XXXX
如果您使用“OAuth 2.0 客户端凭据(包含 JWT 不记名令牌)”连接类型,请完成以下任务:
  • 创建自签名证书,并下载私钥证书和公钥。如需了解详情,请参阅创建自签名证书。
  • 在 Azure AD 应用的“证书和 Secret”下上传公钥证书。
  • 在私钥字段中,通过单个密钥传递私钥证书值和公钥证书值。您无需为私钥和公钥分别创建 Secret。

如需了解如何使用 Postman 建立连接,请参阅使用 API 的 JWT 连接。

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型,并且在 Azure AD 应用中进行了任何配置更改,则必须重新授权 Azure AD (Entra ID) 连接。如需重新授权连接,请执行以下步骤:

  1. 在“连接”页面中,点击所需的连接。

    系统随即会打开连接详情页面。

  2. 点击修改以修改连接详细信息。
  3. 在身份验证部分中,验证 OAuth 2.0 - 授权代码详细信息。

    如有需要,请进行必要的更改。

  4. 点击保存。系统随即会转到连接详情页面。
  5. 在身份验证部分中,点击修改授权。系统会显示授权窗格。
  6. 点击授权。

    如果授权成功,系统会在“连接”页面中将连接状态设置为有效。

创建连接后的其他步骤

如果您选择 OAuth 2.0 - Authorization code 作为身份验证方式,则必须在创建连接后执行以下额外步骤:

  1. 在“连接”页面中,找到新创建的连接。

    请注意,新连接器的状态将为需要授权。

  2. 点击需要授权。

    系统会显示修改授权窗格。

  3. 将重定向 URI 值复制到外部应用。
  4. 验证授权详细信息。
  5. 点击授权。

    如果授权成功,系统会在“连接”页面中将连接状态设置为有效。

配置事件订阅

如果您已启用事件订阅,请在事件订阅详细信息部分中输入以下值:

  1. 输入身份验证详细信息。
    1. 客户端 ID:请求访问令牌时所用的客户端 ID。
    2. 客户端密钥:请求访问令牌时所用的客户端密钥。
    3. 密文版本:选择密文版本。
    4. 客户端状态:包含客户端状态的 Secret Manager 密文。用于更改通知身份验证。
  2. Azure 租户:用于访问数据的 Microsoft Online 租户。如果您未指定租户,系统会使用您的默认租户。
  3. (可选)如果您希望在后端系统的响应中附加其他信息,请选择启用数据丰富化。

    其他信息特定于您为其配置事件的实体。如需了解详情,请参阅事件通知中的数据丰富化。

  4. 选择启用专用连接,以在后端应用与连接之间建立安全连接。如果您选择此选项,则必须在创建连接后执行额外的配置步骤。如需了解详情,请参阅事件订阅的专用连接。
  5. 输入死信配置。如果您配置了死信,连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息:
    1. 死信项目 ID: 您已配置死信 Pub/Sub 主题的 Google Cloud 项目 ID。
    2. 死信主题: 您要将未处理事件的详细信息写入到的 Pub/Sub 主题。
  6. 如果您想使用代理连接到后端(用于订阅活动),请输入以下详细信息:
    1. 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。选择以下任一身份验证类型:
      • 始终:连接始终启用 SSL 以进行事件订阅。
      • 永不:连接未针对事件订阅启用 SSL。
    2. 代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。 支持以下身份验证类型:
      • 基本:基本 HTTP 身份验证。
    3. 代理用户:输入用于向代理服务器进行身份验证的用户名。
    4. 代理密码:选择用户密码的 Secret Manager 密文。
    5. 密文版本:选择密文版本。
    6. 在代理服务器部分中,输入代理服务器的详细信息。
      1. 点击 + 添加目标,然后选择目标类型作为主机地址。
      2. 输入代理服务器的主机名或 IP 地址,以及代理服务器的端口号。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。

    但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,Entities 列表将为空。

  • 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:

    从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则不支持的操作不会列在 Operations 列表中。

  • 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作会包含一些输入参数和一个输出参数。但可能的情况是,连接器不支持任何动作,在这种情况下,Actions 列表将为空。

系统限制

Azure AD (Entra ID) 连接器每秒每个节点可处理 5 笔交易,并会限制超出此限制的任何交易。默认情况下,Integration Connectors 会为连接分配 2 个节点(以提高可用性)。

如需了解适用于 Integration Connectors 的限制,请参阅限制。

操作

本部分列出了连接器支持的部分操作。如需了解如何配置操作,请参阅操作示例。

AddGroupMember 操作

此操作可向群组添加成员。

AddGroupMember 操作的输入参数

参数名称 数据类型 必需 说明
MemberId 字符串 是 会员的唯一标识符。
GroupId 字符串 是 群组的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅操作示例。

RemoveGroupMember 操作

此操作会从群组中移除成员。

RemoveGroupMember 操作的输入参数

参数名称 数据类型 必需 说明
MemberId 字符串 是 会员的唯一标识符。
GroupId 字符串 是 群组的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

AddGroupMember(访客账号)操作

此操作可向群组添加成员。

AddGroupMember 操作的输入参数

参数名称 数据类型 必需 说明
MemberId 字符串 是 会员的唯一标识符。
GroupId 字符串 是 群组的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveGroupMember(访客账号)操作

此操作会从群组中移除成员

RemoveGroupMember 操作的输入参数

参数名称 数据类型 必需 说明
MemberId 字符串 是 会员的唯一标识符。
GroupId 字符串 是 群组的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

AddUserApplicationRoleAssignment 操作

此操作会将用户添加到应用角色分配中。

AddUserApplicationRoleAssignment 操作的输入参数

参数名称 数据类型 必需 说明
ResourceId 字符串 是 资源的唯一标识符。
AppRoleId 字符串 是 应用角色的唯一标识符。
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveUserApplicationRoleAssignment 操作

此操作会从应用角色分配中移除用户。

RemoveUserApplicationRoleAssignment 操作的输入参数

参数名称 数据类型 必需 说明
AppRoleAssignmentId 字符串 是 应用角色分配的唯一标识符。
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

AddGroupApplicationRoleAssignment 操作

此操作会将群组添加到应用角色分配中。/p>

AddGroupApplicationRoleAssignment 操作的输入参数

参数名称 数据类型 必需 说明
ResourceId 字符串 是 资源的唯一标识符。
AppRoleId 字符串 是 应用角色的唯一标识符。
GroupId 字符串 是 群组的唯一标识符

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveGroupApplicationRoleAssignment 操作

此操作会从应用角色分配中移除群组。

RemoveGroupApplicationRoleAssignment 操作的输入参数

参数名称 数据类型 必需 说明
AppRoleAssignmentId 字符串 是 应用角色分配的唯一标识符。
GroupId 字符串 是 群组的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

ActivateDirectoryRole 操作

此操作会激活目录角色。

ActivateDirectoryRole 操作的输入参数

参数名称 数据类型 必需 说明
RoleTemplateId 字符串 是 相应角色所基于的 directoryRoleTemplate 的 ID。

如需查看有关如何配置此操作的示例,请参阅示例。

VerifyDomain 操作

此操作用于验证网域。

VerifyDomain 操作的输入参数

参数名称 数据类型 必需 说明
ID 字符串 是 要验证的网域的 ID。

如需查看有关如何配置此操作的示例,请参阅示例。

ChangePassword 操作

此操作会更改用户的密码。

ChangePassword 操作的输入参数

参数名称 数据类型 必需 说明
NewPassword 字符串 是 用户的新密码。
CurrentPassword 字符串 是 用户的当前密码。

如需查看有关如何配置此操作的示例,请参阅示例。

ResetPassword 操作

此操作会重置用户的密码。

ResetPassword 操作的输入参数

参数名称 数据类型 必需 说明
密码 字符串 是 用户提交的密码,用于重置密码。如果留空,系统会生成密码。
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

AssignLicense 操作

此操作会为用户分配许可。

AssignLicense 操作的输入参数

参数名称 数据类型 必需 说明
UserPrincipalName 字符串 是 需要为其分配许可的用户的委托人名称。请勿提供您登录时使用的用户名。
UserId 字符串 是 需要为其分配许可的用户的 ID。请勿提供您登录时使用的用户名。
AddLicenseSkuId 字符串 是 相应 SKU 的唯一标识符。
DisabledPlans 字符串 否 一组以英文逗号分隔的已停用方案的唯一标识符。
RemoveLicenses 字符串 否 以英文逗号分隔的 GUID 集合,用于标识要移除的许可。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveLicense 操作

此操作会移除分配给用户的许可。

RemoveLicense 操作的输入参数

参数名称 数据类型 必需 说明
UserPrincipalName 字符串 是 需要为其分配许可的用户的委托人名称。请勿提供您登录时使用的用户名。
UserId 字符串 是 需要为其分配许可的用户的 ID。请勿提供您登录时使用的用户名。
AddLicenseSkuId 字符串 否 相应 SKU 的唯一标识符。
DisabledPlans 字符串 否 一组以英文逗号分隔的已停用方案的唯一标识符。
RemoveLicenses 字符串 是 以英文逗号分隔的 GUID 集合,用于标识要移除的许可。

如需查看有关如何配置此操作的示例,请参阅示例。

FetchAdditionalUserFields 操作

此操作会检索必需的属性字段。

FetchAdditionalUserFields 操作的输入参数

参数名称 数据类型 必需 说明
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

AddGroupOwner 操作

此操作可向群组添加所有者。

AddGroupOwner 操作的输入参数

参数名称 数据类型 必需 说明
GroupId 字符串 是 群组的唯一标识符。
OwnerId 字符串 是 所有者的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveGroupOwner 操作

此操作会移除群组所有者。

RemoveGroupOwner 操作的输入参数

参数名称 数据类型 必需 说明
GroupId 字符串 是 群组的唯一标识符。
OwnerId 字符串 是 所有者的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

InviteExternalUser 操作

此操作会邀请外部用户加入组织。

InviteExternalUser 操作的输入参数

参数名称 数据类型 必需 说明
UserEmailAddress 字符串 是 您要邀请的用户的电子邮件地址。
RedirectURL 字符串 是 用户兑换后会被重定向到的网址。

如需查看有关如何配置此操作的示例,请参阅示例。

AddPhoneAuthenticationMethod 操作

此操作可让用户执行特定任务

AddPhoneAuthenticationMethod 操作的输入参数

参数名称 数据类型 必需 说明
UserID 字符串 是 要添加手机身份验证方法的用户 ID。
PhoneNumber 字符串 是 身份验证方法的手机号码。
PHONETYPE 字符串 是 相应身份验证方法的手机类型。可能的值包括:mobile、alternateMobile 和 office。

如需查看有关如何配置此操作的示例,请参阅示例。

RemovePhoneAuthenticationMethod 操作

此操作会移除用户的手机号码身份验证方法。

RemovePhoneAuthenticationMethod 操作的输入参数

参数名称 数据类型 必需 说明
UserID 字符串 是 要移除手机身份验证方法的用户 ID。请勿提供您登录时使用的用户名。
ID 字符串 是 与 phoneType 对应的手机方法 ID。

如需查看有关如何配置此操作的示例,请参阅示例。

UpdatePhoneAuthenticationMethod 操作

此操作会更新用户的手机身份验证方法。

UpdatePhoneAuthenticationMethod 操作的输入参数

参数名称 数据类型 必需 说明
UserID 字符串 是 要更新手机身份验证方法的用户 ID。
ID 字符串 是 与 phoneType 对应的手机方法 ID。
PhoneNumber 字符串 是 身份验证方法的手机号码。

如需查看有关如何配置此操作的示例,请参阅示例。

AddPrivilegedRole 操作

此操作会为用户添加一个特权角色。

AddPrivilegedRole 操作的输入参数

参数名称 数据类型 必需 说明
PrincipalId 字符串 是 已获授予角色资格的主账号的标识符。
RoleDefinitionId 字符串 是 要分配给主账号的 unifiedRoleDefinition 对象的标识符。
理由 字符串 是 用户和管理员提供的消息。
ScheduleInfo 字符串 是 角色资格的期限。

如需查看有关如何配置此操作的示例,请参阅示例。

RemovePrivilegedRole 操作

此操作会移除用户的特权角色。<

RemovePrivilegedRole 操作的输入参数

参数名称 数据类型 必需 说明
PrincipalId 字符串 是 已获授予角色资格的主账号的标识符。
RoleDefinitionId 字符串 是 要向正文移除的 unifiedRoleDefinition 对象的标识符。
理由 字符串 是 用户和管理员提供的消息。

RetrieveUserPhoto 操作

此操作用于检索用户照片。

RetrieveUserPhoto 操作的输入参数

参数名称 数据类型 必需 说明
UserId 字符串 是 您要下载的文件的 ID。
FileLocation 字符串 否 文件存储位置。指定完整的文件路径和文件名。
编码 字符串 否 FileData 输入编码类型。
FileStream 字符串 否 用于写入文件数据的输出流的实例。仅在未提供 FileLocation 时使用。

如需查看有关如何配置此操作的示例,请参阅示例。

UpdateUserPhoto 操作

此操作用于更新用户照片。

UpdateUserPhoto 操作的输入参数

参数名称 数据类型 必需 说明
LocalFile 字符串 否 包含要上传的照片的本地文件位置。指定完整的文件路径和文件名。
ContentStream 字符串 否 当未指定 localpath 或 folderpath 时,要上传的内容(以 InputStream 形式)
UserId 字符串 是 用户的 ID。
内容 字符串 是 要上传的照片内容。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveUserPhoto 操作

此操作会移除用户照片。

RemoveUserPhoto 操作的输入参数

参数名称 数据类型 必需 说明
UserId 字符串 是 用户的 ID。

如需查看有关如何配置此操作的示例,请参阅示例。

AssignManager 操作

此操作可为特定用户分配经理。

AssignManager 操作的输入参数

参数名称 数据类型 必需 说明
ObjectId 字符串 是 对象的唯一标识符。
ObjectName 字符串 是 要添加的 directoryObject、用户或组织联系人对象。
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

RemoveManager 操作

此操作会移除分配给用户的经理。

RemoveManager 操作的输入参数

参数名称 数据类型 必需 说明
UserId 字符串 是 用户的唯一标识符。

如需查看有关如何配置此操作的示例,请参阅示例。

RetrieveManagerChain 操作

此操作用于检索用户的经理。

RetrieveManagerChain 操作的输入参数

参数名称 数据类型 必需 说明
级别 字符串 是 要检索的经理层级数。指定 max 可返回所有经理。
UserId 字符串 是 用户的 ID。

如需查看有关如何配置此操作的示例,请参阅示例。

AddProfileCardProperty 操作

此操作会为组织添加新的 ProfileCardProperty。

AddProfileCardProperty 操作的输入参数

参数名称 数据类型 必需 说明
DirectoryPropertyName 字符串 是 用于标识 profileCardProperty 资源。
注解 字符串 是 允许管理员为目录属性设置自定义显示标签。

如需查看有关如何配置此操作的示例,请参阅示例。

下表列出了对 profilecardproperties 执行 List 和 Get 操作所需的权限:

权限 类型
People.Read.All 应用
PeopleSettings.Read.All 委派
PeopleSettings.Read.All 应用

下表列出了对 profilecardproperties 执行 Create 操作所需的权限:

权限 类型
PeopleSettings.ReadWrite.All 应用
PeopleSettings.ReadWrite.All 委派

RemoveProfileCardProperty 操作

此操作会移除组织的 ProfileCardProperty。

RemoveProfileCardProperty 操作的输入参数

参数名称 数据类型 必需 说明
DirectoryPropertyName 字符串 是 用于标识 profileCardProperty 资源。

如需查看有关如何配置此操作的示例,请参阅示例。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - AddGroupMember

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddGroupMember 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 此操作会返回 AddGroupMember 的确认消息。如果操作成功,AddGroupMember 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveGroupMember

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveGroupMember 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果操作成功,RemoveGroupMember 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - AddGroupMember(访客账号)

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddGroupMember 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果操作成功,AddGroupMember 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveGroupMember(访客账号)

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveGroupMember 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果操作成功,RemoveGroupMember 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - AddUserApplicationRoleAssignment

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddUserApplicationRoleAssignment 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
      "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217"
      }
      
  4. 如果操作成功,AddUserApplicationRoleAssignment 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveUserApplicationRoleAssignment

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveUserApplicationRoleAssignment 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "AppRoleAssignmentId": "bspYNS4s00GoVL-SSaPJE0xC2--0GxxIu8uS4aeindU"
      }
      
  4. 如果操作成功,RemoveUserApplicationRoleAssignment 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - AddGroupApplicationRoleAssignment

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddGroupApplicationRoleAssignment 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
      "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果操作成功,AddGroupApplicationRoleAssignment 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveGroupApplicationRoleAssignment

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveGroupApplicationRoleAssignment 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "AppRoleAssignmentId": "p3luD3g1tEid3t7Pu3uxAMT7DwI3p29HlrxMuZ143eU"
      }
      
  4. 如果操作成功,RemoveGroupApplicationRoleAssignment 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - ActivateDirectoryRole

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 ActivateDirectoryRole 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
     {
      "RoleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033"
      } 
      
  4. 如果操作成功,ActivateDirectoryRole 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "id": "c865d9cb-57da-416c-97a3-753e733da678",
      "roleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033",
      "displayName": "Service Support Administrator",
      "description": "Can read service health information and manage support tickets."
      }]
      

示例 - VerifyDomain

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 VerifyDomain 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "Id": "eternalsolarsolutions.com"
      } 
      
  4. 如果操作成功,VerifyDomain 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - ChangePassword

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 ChangePassword 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "NewPassword": "XXX@9876",
      "CurrentPassword": "XXX@123"
      }
      
  4. 如果操作成功,ChangePassword 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - ResetPassword

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 ResetPassword 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "Password": "XXX@9876",
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
      }
      
  4. 如果操作成功,ResetPassword 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - AssignLicense

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AssignLicense 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
      "AddLicenseSkuId": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
      }
      
  4. 如果操作成功,AssignLicense 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveLicense

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AssignLicense 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
      "RemoveLicenses": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
      }
      
  4. 如果操作成功,RemoveLicense 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - FetchAdditionalUserFields

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 FetchAdditionalUserFields 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      } 
      
  4. 如果操作成功,FetchAdditionalUserFields 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
        "id": "9630c9d7-cf15-4406-8d21-598e41a058cc",
        "deleteddatetime": null,
        "accountenabled": "true",
        "agegroup": null,
        "businessphones": "",
        "city": null,
        "companyname": null,
        "consentprovidedforminor": null,
        "country": null,
        "createddatetime": "2024-04-12T10:24:42Z",
        "creationtype": null,
        "department": null,
        "displayname": "Azure_AD_Test",
        "employeehiredate": null,
        "employeeid": null,
        "employeeleavedatetime": null,
        "employeetype": null,
        "externaluserstate": null,
        "externaluserstatechangedatetime": null,
        "faxnumber": null,
        "givenname": null,
        "imaddresses": "",
        "isresourceaccount": null,
        "jobtitle": null,
        "lastpasswordchangedatetime": "2024-05-14T05:07:15Z",
        "legalagegroupclassification": null,
        "mail": null,
        "mailnickname": "Azure_AD_Test",
        "mobilephone": null,
        "officelocation": null,
        "onpremisesdistinguishedname": null,
        "onpremisesdomainname": null,
        "onpremisesimmutableid": null,
        "onpremiseslastsyncdatetime": null,
        "onpremisessamaccountname": null,
        "onpremisessecurityidentifier": null,
        "onpremisessyncenabled": null,
        "onpremisesuserprincipalname": null,
        "othermails": "",
        "passwordpolicies": null,
        "postalcode": null,
        "preferreddatalocation": null,
        "preferredlanguage": null,
        "proxyaddresses": "",
        "securityidentifier": "S-1-12-1-2519779799-1141296917-2388205965-3428360257",
        "showinaddresslist": null,
        "signinsessionsvalidfromdatetime": "2024-05-14T05:07:15Z",
        "state": null,
        "streetaddress": null,
        "surname": null,
        "usagelocation": "IN",
        "userprincipalname": "Azure_AD_Test@z8474.onmicrosoft.com",
        "usertype": "Member",
        "aboutme": null,
        "birthday": "0001-01-01T08:00:00Z",
        "hiredate": "0001-01-01T08:00:00Z",
        "interests": "",
        "mysite": null,
        "pastprojects": "",
        "preferredname": "",
        "responsibilities": "",
        "schools": "",
        "skills": "",
        "assignedlicenses": "",
        "assignedplans": "[\r\n  {\r\n    \"assignedDateTime\": \"2024-05-16T10:17:45Z\",\r\n    \"capabilityStatus\": \"Deleted\",\r\n    \"service\": \"DynamicsNAV\",\r\n    \"servicePlanId\": \"3f2afeed-6fb5-4bf9-998f-f2912133aead\"\r\n  }\r\n]",
      "authorizationinfo_certificateuserids": "",
      "identities": "[\r\n  {\r\n    \"signInType\": \"userPrincipalName\",\r\n    \"issuer\": \"z8474.onmicrosoft.com\",\r\n    \"issuerAssignedId\": \"Azure_AD_Test@z8474.onmicrosoft.com\"\r\n  }\r\n]",
      "licenseassignmentstates": "",
      "onpremisesextensionattributes_extensionattribute1": null,
      "onpremisesextensionattributes_extensionattribute2": null,
      "onpremisesextensionattributes_extensionattribute3": null,
      "onpremisesextensionattributes_extensionattribute4": null,
      "onpremisesextensionattributes_extensionattribute5": null,
      "onpremisesextensionattributes_extensionattribute6": null,
      "onpremisesextensionattributes_extensionattribute7": null,
      "onpremisesextensionattributes_extensionattribute8": null,
      "onpremisesextensionattributes_extensionattribute9": null,
      "onpremisesextensionattributes_extensionattribute10": null,
      "onpremisesextensionattributes_extensionattribute11": null,
      "onpremisesextensionattributes_extensionattribute12": null,
      "onpremisesextensionattributes_extensionattribute13": null,
      "onpremisesextensionattributes_extensionattribute14": null,
      "onpremisesextensionattributes_extensionattribute15": null,
      "onpremisesprovisioningerrors": "",
      "provisionedplans": "",
      "serviceprovisioningerrors": "",
      "customsecurityattributes": "{\r\n  \"ConnectorTesting\": {\r\n    \"@odata.type\": \"#microsoft.graph.customSecurityAttributeValue\",\r\n    \"FavouriteSport\": \"cricket\",\r\n    \"FavouriteMovie\": \"3 idiots\"\r\n  }\r\n}",
      "signinactivity_lastsignindatetime": "2024-05-14T07:04:51Z",
      "signinactivity_lastsigninrequestid": "ed35b322-d0d9-4fcb-8e71-f9ee7e065e00",
      "signinactivity_lastnoninteractivesignindatetime": "2024-05-15T09:00:02Z",
      "signinactivity_lastnoninteractivesigninrequestid": "0d4ce88b-710a-440f-a612-f590954d6800",
      "signinactivity_lastsuccessfulsignindatetime": "2024-05-15T06:45:42Z",
      "signinactivity_lastsuccessfulsigninrequestid": "64643e9d-3468-4e4d-b7c3-8bd316956600"
      }  
      

示例 - AddGroupOwner

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddGroupOwner 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      }
      
  4. 如果操作成功,AddGroupOwner 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemoveGroupOwner

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveGroupOwner 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      }
      
  4. 如果操作成功,RemoveGroupOwner 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - InviteExternalUser

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 InviteExternalUser 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserEmailAddress": "taleprajyot97@gmail.com",
      "RedirectURL": "https://www.example.com"
      }
      
  4. 此操作会返回 InviteExternalUser 的确认消息。如果操作成功,InviteExternalUser 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True",
      "Id": "70905aef-361f-4cb1-8d04-41f9e377ebd3",
      "ReedemURL": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3d9b25e811-f983-4982-82e4-263c1ca48112%26user%3d70905aef-361f-4cb1-8d04-41f9e377ebd3%26ticket%3dx5aOZc%25252bE9XslKcOdb101qLnoe2V%25252b8%25252beeFlNhYA5WvTg%25253d%26ver%3d2.0",
      "InvitedUserId": "d5eeb199-a544-4985-b726-e3073751050c"
      }]
      

示例 - AddPhoneAuthenticationMethod

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddPhoneAuthenticationMethod 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "PhoneType": "mobile",
      "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
      "PhoneNumber": "+91 9898989890"
      }
      
  4. 如果操作成功,AddPhoneAuthenticationMethod 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RemovePhoneAuthenticationMethod

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemovePhoneAuthenticationMethod 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "PhoneType": "mobile",
      "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
      "PhoneNumber": "+91 9898989890"
      }
      
  4. 如果操作成功,RemovePhoneAuthenticationMethod 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - UpdatePhoneAuthenticationMethod

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 UpdatePhoneAuthenticationMethod 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "securityComplianceNotificationPhones": "9899999999",
      "securityComplianceNotificationMails": "abc@gmail.com"
      }
      
  4. 如果操作成功,UpdatePhoneAuthenticationMethod 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - AddPrivilegedRole

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddPrivilegedRole 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
      "Justification": "Add Privileged Role",
      "ScheduleInfo": "{\n\"StartDateTime\" : \"2022-09-09T21:31:27.91Z\",\n\"Expiration\"    : {\n\"Type\"        : \"Eligible\"}\n}"
      }
      
  4. 如果操作成功,AddPrivilegedRole 任务的 connectorOutputPayload 响应参数的值类似于以下内容:ç

    [{
      "Success": "True"
      }]
      

示例 - RemovePrivilegedRole

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemovePrivilegedRole 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
      "Justification": "Removing Privileage Role"
      }
      
  4. 如果操作成功,RemovePrivilegedRole 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "Success": "True"
      }]
      

示例 - RetrieveUserPhoto

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RetrieveUserPhoto 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "8e22c728-c523-436b-8f46-3b21cc1b5f80"
      } 
      
  4. 如果操作成功,RetrieveUserPhoto 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
        "Status": "Success",
        "FileData": "77+9UE5HDQoaCgAAAA1JSERSAAADUgAAAjYIBgAAAFo077+977+9AAAAAXNSR0IA77+977+9HO+/vQAAAARnQU1BAADvv73vv70L77+9YQUAAAAJcEhZcwAADu+/vQAADu+/vQHvv71v77+9ZAAA77+977+9SURBVHhe77+977+9ZXwcV9K+LWlmZCbvv71O77+977+977+9ZO+/vcmG77+9Ge+/vThmZmZm77+9OO+/vcmG77+977+9MTMzM++/vS0z77+977+977+9eu+/ve+/vXTvv71o77+9KAvvv73vv73vv71w77+9DjRO77+977+9Vl3vv70677+9KWsrR2zvv71zEe+/ve+/vUTvv73vv717KGrvv709EO+/ve+/vWjvv71RG01777+977+9Me+/ve+/vWjvv73vv719OmJLyqfZuu+/vRHvv71ZK++/vQ7Uj9iJ77+977+9du+/vUXEslrvv73vv73vv70uzbzvv70pFu+/vUrvv709Yl4P77+9eu+/vSDvv73vv71n77+977+977+9Gu+/ve+/vV3vv71sP2Vm77+977+9be+/vWbvv707RmxV77+9VFvvv70u77+9Fu+/ve+/vdqi77+9aTbvv71N77+977+9Re+/ve+/vWPvv70tYe+/vRXvv73vv70677+9bu+/vTRbS++/ve+/ve+/vWxkP1vvv71FbWt377+977+9LdW277+977+977+977+977+9ae+/ve+/vXvvv73vv73vv70Z77+9Xe+/vSLvv73vv70X77+977+9E++/vT1ob1/vv71+ae+/ve+/vWx3by1P77+9XT3vv71sL++/ve+/ve+/vWbvv73vv73vv71m77+9F+e0s2vvv712dErvv73vv73vv73vv73vv73vv71p77+977+9Le+/vW/vv73vv71oZ0vvv73vv70577+9R3tb77+92b7vv70R77+977+9KmIHKQ/vv73vv73agdapdu+/vU3vv73vv73vv73vv73vv71zXe+/ve+/ve+/ve+/ve+/vRTvv70777+977+977+96pqK77+9LO+/vXN077+9PO+/ve+/ve+/vVp2f++/vdOgNO+/ve+/veyBlO+/ve+/vQdQ77+9cO+/vTc477+9bBDvv71S77+977+977+977+9Zu+/ve+/vW8I77+977+977+9ZQ8paFnvv70LWnxwYe+/ve+/vVEWNBvvv71O77+977+9eQMKW++/vV8x77+977+9FO+/vd6k77+977+9LmHvv70eRS3erQBiG++/vXXvv71DzLI577+9LO+/vT3vv73vv71077+9Ze+/ve+/ve+/vTcebe+/vWbvv73vv71E77+9UEPvv71r77+9NMus77+9Zu+/ve+/vUVsXe+/ve+/ve+/ve+/ve+/vWZr77+9c29qRG0177+9VdWi77+977+9eu+/ve+/ve+/vUlfTe+/ve+/vW/vv73NujVTbX3vv73vv73vv73vv70V77+9He+/ve+/vXUj77+977+9AdeeMe+/ve+/ve+/ve+/ve+/ve+/vQHvv73vv70Y77+9aFcj77+9Y2Pvv700Zjtpb2vvv73vv73vv73vv73ZmHvXnHvvv70Y77+904Lvv73vv70y77+977+9EO+/ve+/vRjvv73vv71077+9dDvbs++/ve+/vXsX4bqU77+9Wu+/vVsH77+977+977+977+9P1vvv73vv70y77+9fO+/ve+/vV8pZd6rJe+/vXvvv70cy6Yef++/ve+/vWXvv71U1LJf77+9Wg3vv73vv71j1otF77+9NO+/ve+/vQTvv73vv70A77+9SO+/vWZHD++/vQ3vv71ta++/ve+/ve+/veO+rmDvv73vv73vv71c77+9cD1+77+9Hu+/ve+/vSpG77+977+9Y++/ve+/vWfvv73vv73vv70zMXvvv73vv73vv73
      ...[too long to view on UI. Please use the API to view the full content.]
      

示例 - UpdateUserPhoto

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 UpdateUserPhoto 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc",
      "Content": "iVBORw0KGgoAAAANSUhEUgAAA1IAAAI2CAIAAADVVi6oAAAgAElEQVR4AZy9d3Rc1dX3r3POHVmWrG6ckIQHN0gCCYEkT/IkJA89lARc1Xsf1ZlR78W2iis4BFuybMAFMMW4qctFknu31XvvzTbu0tx9fmufOzMWJe+b97fWXmede2ekBYs/8sm3bJm1uLAry9jJt2jFq9Khl6XDL0vFr0ilr0pHXlMdf52ee5tdXU5b3diAN50IYHdCyYMINh1FIJpCnJmcRCGFQSqBdDNIJzhp5H4Su5FIx5PYYDzrjaVdcaxRS+qjyWWNdFlHL2jZBR27ECNdiqNX41l9HG1MYI0JtCWBtSTSjiTWnSz1pNCuZNKXKvWl0e4U0p/GhtLZcDodz2QjmWw0i42soiOZdDiDDaXToVQ6ms76k2lvEuuKZ71xbCBJ6o+nA7F0IIb260ifhg5p6EAkHdGycS0bjaJjGjYWxSY17IZOmtCQ61p6P0a6HU1vRtPbsfRePH2QQO8lkXtJdDqN4aRTfRbRryaQQ+Ucqs+mshj9GiqvocpLyKU8h0CueMwmPJtCDoE8CtlMn2cxnWsh51pCnrWca8FzzSHPAtZYyqusIdMG0s15hq2cOkdOniUnW8hxVI5V6WPpdDSd1kn3IsndKPZNOL2hZteD6HgAHfSnff6s1ZM1u9NmD9biKTW500Z3qdGDNnmxFi+pyYO2+7BWL9Lmy9q8WbuP1OHHegJZVwDr8qc9gawvkPYF0cEgOhTMhkPYcKhqIIj2BpP+IDoQQkfD2WgEG4mgY5EqPCPodS27FUfvJ5lPpVnJGVaQbS9n28o5c+V1j+rXzYWN8+RN9vCuLWyep99kL2901G+Yo19rAevw33p6vdX9XPM72Wwiiw2l0v5U1p9Ge1Kk1gRaH8dOR7Ayf/alh2qnk7RjhWrbUmnLO6p332DrX6fZr0iZL7KUF1jCn1TaP86K/P2siN9Zhj43R/1b68DfWPv+ysbrlw5uT9g6L7JducjeeZGjy6J5zo/buyxwdF9g77nIwfcJ+9Bfzo34pX3MMw4Jv7LP/K3tpj/b5L9gu/0Fq89fn130zpzyFXNOONuecZ1z0WtOnd+ctiDrjkCbwTDH4Qjrm9qf3on9yd34H02n/Jc+9TFIf1xOX6hPexwyF0Da49NJj00nPXYndt7tuB9N6hyGImx71datfrOueNHTrtKR5axkmVS2fHaN67wLvovq1c+26f7cl/zqZPbye5u99NuC4JMI2B8LFelwIodffg/qtkBzIbTthI5dvHMP7/4cp+dL3vcVH9jPBw/CUDEfKYPRMj5Wzscq+dgRPirOh5dK8VH5d04YKYVR8YOj5TBSir9kpIwPlcJwKQyXwHAJFwNDxfg4VGx6lAcP8YGHA/0H8bH/EO8Tl76DeOk7CP378Z+wfx/v3wf9+6Dva7kXT+jbB31fQe9X0P0V79mH0/0V71LmS979BXR9bjp59xe86wve+Tl07OWdnxtnL+/cCx2fKcM7PoP2T6H9Uy5OaPuEt38C7Z/wtj3Qsou37sZp2cNb9sgte3gzDjTv4U27efNO3vwxb/4Ip0lM807etBMaP4KGHdCwgzd+iO8bP+SNH0KT4aXhfcN2qC/k9dvlum1Qvw3qxGPdNj5joN74WFsw8z3eDW8KeJ34qLYA3xhHrsuH+nxel89r83ndVsPP1hZA7VbAx628Lh8atvLGfF6/Va4v4LVbceryeaPxfWM+NObzhgLegC+VAeXeUIAX/KgA3xu/gL+wYSv+lGmMH+GbpgLT4HdmPP7f780FvHnrw2nZyvHNNpyWfN4i7k3boLmAt4pp2cZbC7npbNnGWwrxo5Z8aM0X39kGbQWG6djK2/OhrYC35z+cjnxow/e8Ix/E8M4C6MjnnQUPp2sb79qGj8rZOeOufPS9E7rF
      ...[too long to view on UI. Please use the API to view the full content.]
      
  4. 如果操作成功,UpdateUserPhoto 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
      "Status": "Success"
      }]
      

示例 - RemoveUserPhoto

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveUserPhoto 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
     {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      } 
      
  4. 如果操作成功,RemoveUserPhoto 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
      "Status": "Success"
      }]
      

示例 - AssignManager

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AssignManager 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "ObjectId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "ObjectName": "users"
      }
      
  4. 如果操作成功,AssignManager 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
      "Status": "True"
      }]
      

示例 - RemoveManager

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveManager 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
      } 
      
  4. 如果操作成功,RemoveManager 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
      "Status": "True"
      }]
      

示例 - RetrieveManagerChain

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RetrieveManagerChain 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
      "UserId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "Levels": "max"
      }
      
  4. 如果操作成功,RetrieveManagerChain 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

    [{
      "id": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "displayName": "test1",
      "manager": "{\r\n  \"@odata.type\": \"#microsoft.graph.user\",\r\n  \"id\": \"9630c9d7-cf15-4406-8d21-598e41a058cc\",\r\n  \"deletedDateTime\": null,\r\n  \"accountEnabled\": true,\r\n  \"ageGroup\": null,\r\n  \"businessPhones\": [],\r\n  \"city\": null,\r\n  \"companyName\": null,\r\n  \"consentProvidedForMinor\": null,\r\n  \"country\": null,\r\n  \"createdDateTime\": \"2024-04-12T10:24:42Z\",\r\n  \"creationType\": null,\r\n  \"department\": null,\r\n  \"displayName\": \"Azure_AD_Test\",\r\n  \"employeeId\": null,\r\n  \"employeeHireDate\": null,\r\n  \"employeeLeaveDateTime\": null,\r\n  \"employeeType\": null,\r\n  \"externalUserState\": null,\r\n  \"externalUserStateChangeDateTime\": null,\r\n  \"faxNumber\": null,\r\n  \"givenName\": null,\r\n  \"isLicenseReconciliationNeeded\": false,\r\n  \"jobTitle\": null,\r\n  \"legalAgeGroupClassification\": null,\r\n  \"mail\": null,\r\n  \"mailNickname\": \"Azure_AD_Test\",\r\n  \"mobilePhone\": null,\r\n  \"onPremisesDistinguishedName\": null,\r\n  \"onPremisesDomainName\": null,\r\n  \"onPremisesImmutableId\": null,\r\n  \"onPremisesLastSyncDateTime\": null,\r\n  \"onPremisesSecurityIdentifier\": null,\r\n  \"onPremisesSamAccountName\": null,\r\n  \"onPremisesSyncEnabled\": null,\r\n  \"onPremisesUserPrincipalName\": null,\r\n  \"otherMails\": [],\r\n  \"passwordPolicies\": null,\r\n  \"officeLocation\": null,\r\n  \"postalCode\": null,\r\n  \"preferredDataLocation\": null,\r\n  \"preferredLanguage\": null,\r\n  \"proxyAddresses\": [],\r\n  \"refreshTokensValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"imAddresses\": [],\r\n  \"isResourceAccount\": null,\r\n  \"showInAddressList\": null,\r\n  \"securityIdentifier\": \"S-1-12-1-2519779799-1141296917-2388205965-3428360257\",\r\n  \"signInSessionsValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"state\": null,\r\n  \"streetAddress\": null,\r\n  \"surname\": null,\r\n  \"usageLocat
      ...[too long to view on UI. Please use the API to view the full content.]
      

示例 - AddProfileCardProperty

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 AddProfileCardProperty 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
     {
    "Annotations": "[{"displayName": "Attributes"}]",
    "DirectoryPropertyName": "CustomAttribute15"
    }
  4. 如果操作成功,AddProfileCardProperty 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
    "Status": "True"
    }]

示例 - RemoveProfileCardProperty

  1. 在 Configure connector task 对话框中,点击 Actions。
  2. 选择 RemoveProfileCardProperty 操作,然后点击完成。
  3. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
    "DirectoryPropertyName": "CustomAttribute12"
    } 
  4. 如果操作成功,RemoveProfileCardProperty 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

     [{
    "Status": "True"
    }]

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出群组

  1. 在 Configure connector task 对话框中,点击 Entities。
  2. 从 Entity 列表中选择“群组”。
  3. 选择 LIST 操作,然后点击完成。
  4. 连接器任务的任务输入部分中,您可以根据客户要求设置 filterClause。

您必须使用单引号 (') 将过滤条件子句的值括起来。您可以使用过滤条件子句根据列过滤记录。

您还可以对以下实体执行 LIST 操作:

  • 用户
  • GroupMembers
  • 网域
  • RoleAssignments
  • 应用
  • 设备
  • 通讯录
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • SubscribedSKUs
  • PhoneAuthenticationMethod
  • 组织
  • DeviceLocalCredentials
  • ProfileCardProperties

示例 - 从群组中获取单个记录

  1. 在 Configure connector task 对话框中,点击 Entities。
  2. 从 Entity 列表中选择“群组”。
  3. 选择 GET 操作,然后点击完成。
  4. 将实体 ID 设置为“bb4756c7-38c0-426b-97aa-03b6443e7f16”,这是要传递的密钥。如需设置实体 ID,请在数据映射的数据映射器部分中,点击打开数据映射编辑器,然后在输入值字段中输入 "bb4756c7-38c0-426b-97aa-03b6443e7f16",并选择 EntityId 作为局部变量。

您还可以对以下实体执行 GET 操作:

  • 用户
  • GroupMembers
  • 网域
  • RoleAssignments
  • 应用
  • 设备
  • 通讯录
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • PhoneAuthenticationMethod
  • 组织
  • UserManagers
  • DeviceLocalCredentials

示例 - 从群组中删除记录

  1. 在 Configure connector task 对话框中,点击 Entities。
  2. 从 Entity 列表中选择“群组”。
  3. 选择 DELETE 操作,然后点击完成。
  4. 将实体 ID 设置为“62008bbe-effa-4341-9d29-eac7f67b84fe”,这是要传递的密钥。如需设置实体 ID,请在数据映射的数据映射器部分中,点击打开数据映射编辑器,然后在输入值字段中输入 "62008bbe-effa-4341-9d29-eac7f67b84fe",并选择 EntityId 作为局部变量。

    如果存在两个复合键或主键,则传递实体 ID 可能会引发错误。在这种情况下,您可以使用过滤条件子句,例如 id='62008bbe-effa-4341-9d29-eac7f67b84fe'。

您还可以对以下实体执行 DELETE 操作:

  • 用户
  • 网域
  • 应用
  • 设备
  • 示例 - 创建群组 (Microsoft 365) 实体

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择“群组”。
    3. 选择 Create 操作,然后点击完成。
    4. 在数据映射任务的数据映射器部分中,点击 Open Data Mapping Editor,然后在 Input Value 字段中输入类似于以下内容的值,并选择 EntityId/ConnectorInputPayload 作为局部变量。
      {
      "securityEnabled": true,
      "displayName": "GoogleGCP",
      "description": "This Group is creating for gcp testing.",
      "mailEnabled": false,
      "mailNickname": "GoogleGCP",
      "groupTypes": "Unified"
      }

      此示例会创建 Groups 记录。如果集成成功,Groups 任务的 connectorOutputPayload 响应参数的值类似于以下内容:

      {
      "id": "30fc13b3-79b3-4ac5-a3ba-684d4e887ecc"
      } 

    示例 - 更新用户

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择“用户”。
    3. 选择 Update 操作,然后点击完成。
    4. 在数据映射任务的数据映射器部分中,点击 Open Data Mapping Editor,然后在 Input Value 字段中输入类似于以下内容的值,并选择 EntityId/ConnectorInputPayload/FilterClause 作为局部变量。
      {
      "jobTitle": "Software Engineer"
      }
    5. 在数据映射器中,将实体 ID 设置为“用户”实体。如需设置实体 ID,请点击 Open Data Mapping Editor,然后在 Input Value 字段中输入类似于以下内容的值,并选择 EntityId/ConnectorInputPayload/FilterClause 作为局部变量。

      或者,您也可以将 filterClause 设置为 7ad59ec3-1c37-4932-be51-7513fe98c3c3,而不是指定 entityId。

      此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应:

      {
      "id": "7ad59ec3-1c37-4932-be51-7513fe98c3c3"
      } 

    在集成中使用 Azure AD (Entra ID) 连接

    创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

    • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务。
    • 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务。

    向 Google Cloud 社区寻求帮助

    您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

    后续步骤