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」>「Connections」頁面,然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」,開啟「建立連線」頁面。
  3. 在「位置」部分中,選擇連線的位置。
    1. 區域:從下拉式清單中選取位置。

      連接器支援的地區包括:

      如需所有支援區域的清單,請參閱「地點」一文。

    2. 點選「下一步」。
  4. 在「連線詳細資料」部分,完成下列步驟:
    1. 連接器:從可用連接器的下拉式清單中,選取「Azure AD (Entra ID)」。
    2. 連接器版本:從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中,輸入連線執行個體的名稱。

      連線名稱必須符合下列條件:

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 服務帳戶:選取具備必要角色的服務帳戶。
    6. 視需要設定「連線節點設定」:

      • 節點數下限:輸入連線節點的數量下限。
      • 節點數上限:輸入連線節點數上限。

      節點是用來處理交易的連線單位 (或備用資源)。如要處理更多連線交易,就需要更多節點;反之,如要處理較少的交易,則需要較少的節點。如要瞭解節點對連線器價格的影響,請參閱「 連線節點的定價」。如未輸入任何值,系統預設會將節點下限設為 2 (提高可用性),節點上限則設為 50。

    7. 如要將連線用於事件訂閱,請選取「啟用事件訂閱」。選取這個選項後,會顯示下列選項:
      • 啟用事件訂閱功能,並使用實體和動作:選取這個選項,即可將連線用於事件訂閱和連結器作業 (實體和動作)。
      • 只啟用事件訂閱項目:選取這個選項,即可只將連線用於事件訂閱。如果選取這個選項,請按一下「下一步」,然後設定事件訂閱。
    8. 「Azure Tenant」(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 持有者
    • 私密金鑰:Secret Manager 密鑰,內含 PEM 格式的私密金鑰檔案內容。私密金鑰必須與公開金鑰/憑證相符。
    • 私密金鑰密碼:Secret Manager 密鑰,內含私密金鑰檔案的密碼 (同義詞)。
    • 密鑰版本:私密金鑰密鑰的版本。
    • 用戶端 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
密鑰版本 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
密鑰版本 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
密鑰版本 1
用戶端 ID XXXX
使用 OAuth 2.0 用戶端憑證和 JWT 不記名連線類型時,請完成下列工作:
  • 建立自行簽署的憑證,並下載私密金鑰憑證和公用金鑰。詳情請參閱「建立自行簽署的憑證」。
  • 在 Azure AD 應用程式的「憑證和密鑰」下方,上傳公用金鑰憑證。
  • 在私密金鑰欄位中,以單一密鑰傳遞私密金鑰憑證值和公用金鑰憑證值。您不必為私密和公開金鑰分別建立密鑰。

如要瞭解如何使用 Postman 建立連線,請參閱「使用 API 建立 JWT 連線」。

重新授權授權碼

如果您使用 Authorization code 驗證類型,且已在 Azure AD 應用程式中進行任何設定變更,就必須重新授權 Azure AD (Entra ID) 連線。如要重新授權連結,請按照下列步驟操作:

  1. 在「連線」頁面中,按一下所需連線。

    系統隨即會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「Authentication」部分,驗證「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行必要變更。

  4. 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
  5. 在「驗證」部分中,按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
  6. 按一下「Authorize」。

    授權成功後,「連線」頁面中的連線狀態會設為「有效」。

建立連結後需執行的其他步驟

如果您選取 OAuth 2.0 - Authorization code 進行驗證,建立連線後必須執行下列額外步驟:

  1. 在「連線」頁面中,找出新建立的連線。

    請注意,新連接器的「狀態」會顯示「需要授權」。

  2. 按一下「需要授權」。

    系統隨即會顯示「編輯授權」窗格。

  3. 將「重新導向 URI」值複製到外部應用程式。
  4. 確認授權詳細資料。
  5. 按一下「Authorize」。

    授權成功後,「連線」頁面中的連線狀態會設為「有效」。

設定事件訂閱

如果您已啟用事件訂閱功能,請在「Event Subscription Details」(事件訂閱詳細資料) 區段中輸入下列值:

  1. 輸入驗證詳細資料。
    1. 用戶端 ID:用於要求存取權杖的用戶端 ID。
    2. 用戶端密鑰:用於要求存取權杖的用戶端密鑰。
    3. 密鑰版本:選取密鑰版本。
    4. 用戶端狀態:包含用戶端狀態的 Secret Manager 密鑰。這項資訊用於驗證變更通知。
  2. 「Azure Tenant」(Azure 租戶):用於存取資料的 Microsoft Online 租戶。如未指定租戶,系統會使用預設租戶。
  3. 如要將額外資訊附加至後端系統的回應,請視需要選取「啟用資料充實」。

    額外資訊是針對您設定事件的實體提供。詳情請參閱「在事件通知中擴充資料」。

  4. 選取「啟用私人連線」,在後端應用程式和連線之間建立安全連線。如果選取這個選項,建立連線後必須執行額外設定步驟。詳情請參閱「活動訂閱的私人連線」。
  5. 輸入 dead-letter 設定。如果設定 dead-letter,連線會將未處理的事件寫入指定的 Pub/Sub 主題。輸入下列詳細資料:
    1. 無法傳送的訊息專案 ID: 您已設定無法傳送的訊息 Pub/Sub 主題的 Google Cloud 專案 ID。
    2. 無效信件主題: 要寫入未處理事件詳細資料的 Pub/Sub 主題。
  6. 如要使用 Proxy 連線至後端 (適用於事件訂閱),請輸入下列詳細資料:
    1. Proxy SSL Type:連線至 Proxy 伺服器時要使用的 SSL 類型。選取下列任一驗證類型:
      • 「Always」(一律):連線一律啟用 SSL,以訂閱事件。
      • 「永不」:事件訂閱的連線未啟用 SSL。
    2. Proxy Auth Scheme:選取要用於 Proxy 伺服器驗證的驗證類型。 支援的驗證類型如下:
      • 基本:基本 HTTP 驗證。
    3. Proxy 使用者:輸入要用於 Proxy 伺服器驗證的使用者名稱。
    4. Proxy 密碼:選取使用者密碼的 Secret Manager 密鑰。
    5. 密鑰版本:選取密鑰版本。
    6. 在「Proxy 伺服器」部分,輸入 Proxy 伺服器的詳細資料。
      1. 按一下「+ 新增目的地」,然後選取「目的地類型」為「主機地址」。
      2. 輸入 Proxy 伺服器的主機名稱或 IP 位址,以及 Proxy 伺服器的通訊埠號碼。

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體: 實體可以視為已連結應用程式或服務中的物件,或是屬性集合。實體的定義與連接器對連接器不同。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。

    不過,連接器可能不支援或沒有任何實體,在這種情況下,Entities 清單會是空白。

  • 作業: 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作:

    從可用清單中選取實體,系統會產生該實體可用的作業清單。如需作業的詳細說明,請參閱連線器工作中的實體作業。 不過,如果連接器不支援任何實體作業,Operations 清單就不會列出這類不支援的作業。

  • 動作: 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體,且因連接器而異。一般來說,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,此時 Actions 清單會是空白。

系統限制

Azure AD (Entra ID) 連接器每秒可處理 5 筆交易,每個節點也是如此,超過此限制的交易都會遭到節流。根據預設,Integration Connectors 會為連線分配 2 個節點 (提高可用性)。

如要瞭解 Integration Connectors 適用的限制,請參閱「限制」一文。

動作

本節列出連接器支援的部分動作。如要瞭解如何設定動作,請參閱「動作範例」。

AddGroupMember 動作

這項動作會將成員新增至群組。

AddGroupMember 動作的輸入參數

參數名稱 資料類型 必填 說明
MemberId 字串 是 成員的專屬 ID。
GroupId 字串 是 群組的專屬 ID。

如需如何設定這項動作的範例,請參閱「動作範例」。

RemoveGroupMember 動作

這項操作會將成員從群組中移除。

RemoveGroupMember 動作的輸入參數

參數名稱 資料類型 必填 說明
MemberId 字串 是 成員的專屬 ID。
GroupId 字串 是 群組的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AddGroupMember(Guest Account) 動作

這項動作會將成員新增至群組。

AddGroupMember 動作的輸入參數

參數名稱 資料類型 必填 說明
MemberId 字串 是 成員的專屬 ID。
GroupId 字串 是 群組的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveGroupMember (Guest Account) 動作

這項操作會將成員從群組中移除

RemoveGroupMember 動作的輸入參數

參數名稱 資料類型 必填 說明
MemberId 字串 是 成員的專屬 ID。
GroupId 字串 是 群組的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AddUserApplicationRoleAssignment 動作

這項操作會將使用者新增至應用程式角色指派。

AddUserApplicationRoleAssignment 動作的輸入參數

參數名稱 資料類型 必填 說明
ResourceId 字串 是 資源的專屬 ID。
AppRoleId 字串 是 應用程式角色的專屬 ID。
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveUserApplicationRoleAssignment 動作

這項操作會從應用程式角色指派中移除使用者。

RemoveUserApplicationRoleAssignment 動作的輸入參數

參數名稱 資料類型 必填 說明
AppRoleAssignmentId 字串 是 應用程式角色指派的專屬 ID。
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AddGroupApplicationRoleAssignment 動作

這項動作會將群組新增至應用程式角色指派項目。/p>

AddGroupApplicationRoleAssignment 動作的輸入參數

參數名稱 資料類型 必填 說明
ResourceId 字串 是 資源的專屬 ID。
AppRoleId 字串 是 應用程式角色的專屬 ID。
GroupId 字串 是 群組的專屬 ID

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveGroupApplicationRoleAssignment 動作

這項操作會從應用程式角色指派作業中移除群組。

RemoveGroupApplicationRoleAssignment 動作的輸入參數

參數名稱 資料類型 必填 說明
AppRoleAssignmentId 字串 是 應用程式角色指派的專屬 ID。
GroupId 字串 是 群組的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

ActivateDirectoryRole 動作

這項操作會啟用目錄角色。

ActivateDirectoryRole 動作的輸入參數

參數名稱 資料類型 必填 說明
RoleTemplateId 字串 是 角色所依據的 directoryRoleTemplate ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

VerifyDomain 動作

這項動作會驗證網域。

VerifyDomain 動作的輸入參數

參數名稱 資料類型 必填 說明
ID 字串 是 要驗證的網域 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

ChangePassword 動作

這項操作會變更使用者的密碼。

ChangePassword 動作的輸入參數

參數名稱 資料類型 必填 說明
NewPassword 字串 是 使用者的新密碼。
CurrentPassword 字串 是 使用者目前的密碼。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

ResetPassword 動作

這項操作會重設使用者密碼。

ResetPassword 動作的輸入參數

參數名稱 資料類型 必填 說明
密碼 字串 是 使用者提交的密碼,系統會將密碼重設為這個值。如果留空,系統會產生密碼。
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AssignLicense 動作

這項操作會為使用者指派授權。

AssignLicense 動作的輸入參數

參數名稱 資料類型 必填 說明
UserPrincipalName 字串 是 需要指派授權的使用者主體名稱。請勿提供您登入時使用的使用者名稱。
UserId 字串 是 需要指派授權的使用者 ID。請勿提供您用來登入的使用者名稱。
AddLicenseSkuId 字串 是 SKU 的專屬 ID。
DisabledPlans 字串 否 以半形逗號分隔的方案專屬 ID 集合,這些方案已停用。
RemoveLicenses 字串 否 以半形逗號分隔的 GUID 集合,用於識別要移除的授權。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveLicense 動作

這項操作會移除指派給使用者的授權。

RemoveLicense 動作的輸入參數

參數名稱 資料類型 必填 說明
UserPrincipalName 字串 是 需要指派授權的使用者主體名稱。請勿提供您用來登入的使用者名稱。
UserId 字串 是 需要指派授權的使用者 ID。請勿提供您用來登入的使用者名稱。
AddLicenseSkuId 字串 否 SKU 的專屬 ID。
DisabledPlans 字串 否 以半形逗號分隔的方案專屬 ID 集合,這些方案已停用。
RemoveLicenses 字串 是 以半形逗號分隔的 GUID 集合,用於識別要移除的授權。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

FetchAdditionalUserFields 動作

這項操作會擷取必要屬性欄位。

FetchAdditionalUserFields 動作的輸入參數

參數名稱 資料類型 必填 說明
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AddGroupOwner 動作

這項動作會將擁有者新增至群組。

AddGroupOwner 動作的輸入參數

參數名稱 資料類型 必填 說明
GroupId 字串 是 群組的專屬 ID。
OwnerId 字串 是 擁有者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveGroupOwner 動作

這項操作會移除群組擁有者。

RemoveGroupOwner 動作的輸入參數

參數名稱 資料類型 必填 說明
GroupId 字串 是 群組的專屬 ID。
OwnerId 字串 是 擁有者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

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 字串 是 已獲角色資格的主體 ID。
RoleDefinitionId 字串 是 指派給主體的 unifiedRoleDefinition 物件 ID。
原因 字串 是 使用者和管理員提供的訊息。
ScheduleInfo 字串 是 角色資格的期限。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemovePrivilegedRole 動作

這項操作會移除使用者的特權角色。<

RemovePrivilegedRole 動作的輸入參數

參數名稱 資料類型 必填 說明
PrincipalId 字串 是 已獲角色資格的主體 ID。
RoleDefinitionId 字串 是 要從主體移除的 unifiedRoleDefinition 物件 ID。
原因 字串 是 使用者和管理員提供的訊息。

RetrieveUserPhoto 動作

這項動作會擷取使用者相片。

RetrieveUserPhoto 動作的輸入參數

參數名稱 資料類型 必填 說明
UserId 字串 是 要下載的檔案 ID。
FileLocation 字串 否 檔案儲存位置。指定完整檔案路徑和檔案名稱。
編碼 字串 否 FileData 輸入編碼類型。
FileStream 字串 否 輸出串流的執行個體,檔案資料會寫入其中。只有在未提供 FileLocation 時才會使用。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

UpdateUserPhoto 動作

這項動作會更新使用者相片。

UpdateUserPhoto 動作的輸入參數

參數名稱 資料類型 必填 說明
LocalFile 字串 否 含有要上傳相片的本機檔案位置。請指定完整檔案路徑和檔案名稱。
ContentStream 字串 否 未指定 localpath 或 folderpath 時要上傳的 InputStream 內容
UserId 字串 是 使用者 ID。
內容 字串 是 要上傳的相片內容。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveUserPhoto 動作

這項操作會移除使用者相片。

RemoveUserPhoto 動作的輸入參數

參數名稱 資料類型 必填 說明
UserId 字串 是 使用者 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AssignManager 動作

這項操作會為特定使用者指派經理。

AssignManager 動作的輸入參數

參數名稱 資料類型 必填 說明
ObjectId 字串 是 物件的專屬 ID。
ObjectName 字串 是 要新增的 directoryObject、user 或機構聯絡人物件。
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RemoveManager 動作

這項操作會移除指派給使用者的經理。

RemoveManager 動作的輸入參數

參數名稱 資料類型 必填 說明
UserId 字串 是 使用者的專屬 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

RetrieveManagerChain 動作

這項動作會擷取使用者的經理。

RetrieveManagerChain 動作的輸入參數

參數名稱 資料類型 必填 說明
層級數 字串 是 要擷取的經理層級數量。指定 max 即可傳回所有管理員。
UserId 字串 是 使用者 ID。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

AddProfileCardProperty 動作

這項動作會為機構新增 ProfileCardProperty。

AddProfileCardProperty 動作的輸入參數

參數名稱 資料類型 必填 說明
DirectoryPropertyName 字串 是 識別 profileCardProperty 資源。
註解 字串 是 管理員可以為目錄資源設定自訂顯示標籤。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

下表列出對 profilecardproperties 執行 List 和 Get 作業所需的權限:

權限 類型
People.Read.All 應用程式
PeopleSettings.Read.All 委派型
PeopleSettings.Read.All 應用程式

下表列出對 profilecardproperties 執行「建立」動作所需的權限:

權限 類型
PeopleSettings.ReadWrite.All 應用程式
PeopleSettings.ReadWrite.All 委派型

RemoveProfileCardProperty 動作

這項操作會移除機構的 ProfileCardProperty。

RemoveProfileCardProperty 動作的輸入參數

參數名稱 資料類型 必填 說明
DirectoryPropertyName 字串 是 識別 profileCardProperty 資源。

如要瞭解如何設定這項動作的範例,請參閱「範例」。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - AddGroupMember

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「AddGroupMember」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果動作成功,RemoveGroupMember 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

    [{
      "Success": "True"
      }]
      

範例 - AddGroupMember(Guest Account)

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「AddGroupMember」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. 如果動作成功,AddGroupMember 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

    [{
      "Success": "True"
      }]
      

範例 - RemoveGroupMember(Guest Account)

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「RemoveGroupMember」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "Id": "eternalsolarsolutions.com"
      } 
      
  4. 如果動作成功,VerifyDomain 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

    [{
      "Success": "True"
      }]
      

範例 - ChangePassword

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「ChangePassword」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "NewPassword": "XXX@9876",
      "CurrentPassword": "XXX@123"
      }
      
  4. 如果動作成功,ChangePassword 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

    [{
      "Success": "True"
      }]
      

範例 - ResetPassword

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「ResetPassword」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "securityComplianceNotificationPhones": "9899999999",
      "securityComplianceNotificationMails": "abc@gmail.com"
      }
      
  4. 如果動作成功,UpdatePhoneAuthenticationMethod 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

    [{
      "Success": "True"
      }]
      

範例 - AddPrivilegedRole

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「AddPrivilegedRole」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
     {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      } 
      
  4. 如果動作成功,RemoveUserPhoto 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

     [{
      "Status": "Success"
      }]
      

範例 - AssignManager

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「AssignManager」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
      } 
      
  4. 如果動作成功,RemoveManager 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值:

     [{
      "Status": "True"
      }]
      

範例 - RetrieveManagerChain

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「RetrieveManagerChain」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
     {
    "Annotations": "[{"displayName": "Attributes"}]",
    "DirectoryPropertyName": "CustomAttribute15"
    }
  4. 如果動作成功,AddProfileCardProperty 工作的 connectorOutputPayload 回應參數值會類似以下內容:

     [{
    "Status": "True"
    }]

範例 - RemoveProfileCardProperty

  1. 在 Configure connector task 對話方塊中,按一下 Actions。
  2. 選取「RemoveProfileCardProperty」動作,然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 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 工作的 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。

      這個範例會在 Connector 工作的 connectorOutputPayload 輸出變數中,傳回類似下列內容的回應:

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

    在整合中,使用 Azure AD (Entra ID) 連線

    建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

    • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作,請參閱「連接器工作」。
    • 如要瞭解如何在 Application Integration 中建立及使用連接器工作,請參閱「連接器工作」。

    向 Google Cloud 社群尋求協助

    如要發布問題及討論這個連接器,請前往 Cloud 論壇的 Google Cloud 社群。

    後續步驟