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
(連接器 API)
如要瞭解如何啟用服務,請參閱「啟用服務」。
如果先前未為專案啟用這些服務或權限,系統會在設定連接器時提示您啟用。
- 建立 Azure AD (Entra ID) 連線前,請先在 Azure 入口網站/Microsoft Entra ID 中建立應用程式。詳情請參閱「快速入門:透過 Microsoft 身分識別平台註冊應用程式」和「在 Microsoft Entra ID 中註冊用戶端應用程式」。
設定連接器
連線是特定資料來源的連線,也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新連線」,開啟「建立連線」頁面。
- 在「位置」部分,選擇連線的位置。
- 區域:從下拉式清單中選取位置。
支援的連接器地區包括:
如需所有支援地區的清單,請參閱「位置」一節。
- 點選「下一步」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分中,完成下列操作:
- 連接器:從可用連接器的下拉式清單中選取「Azure AD (Entra ID)」。
- 連接器版本:從可用版本的下拉式清單中選取連接器版本。
- 在「Connection Name」欄位中,輸入連線例項的名稱。
連線名稱必須符合下列條件:
- 連線名稱可以包含英文字母、數字或連字號。
- 字母必須為小寫。
- 連線名稱的開頭必須為英文字母,結尾則須為英文字母或數字。
- 連結名稱不得超過 49 個半形字元。
- 視需要輸入連線例項的「Description」(說明)。
- 服務帳戶:選取具備必要角色的服務帳戶。
- 視需要設定連線節點設定:
- 節點數量下限:輸入連線節點數量下限。
- 節點數量上限:輸入連線節點數量上限。
節點是用來處理交易的連線單位 (或備用資源)。處理的交易量越多,就需要越多節點;反之,處理的交易量越少,就需要越少節點。如要瞭解節點對連接器定價的影響,請參閱「 連線節點的定價」。如果您未輸入任何值,系統預設會將最小節點設為 2 (以提高可用性),並將最大節點設為 50。
- 如要將連線用於事件訂閱,請選取「啟用事件訂閱」。選取這個選項後,系統會顯示下列選項:
- 啟用事件訂閱功能,並使用實體和動作:選取這個選項,即可同時使用連線進行事件訂閱和連接器作業 (實體和動作)。
- 僅啟用事件訂閱功能:選取這個選項,即可只將連線用於事件訂閱。如果選取這個選項,請按一下「下一步」,然後設定事件訂閱項目。
- Azure 用戶群:用於存取資料的 Microsoft Online 用戶群。如未指定,系統會使用您的預設租用戶。
- 為使用者擷取擴充功能屬性:決定是否擷取擴充功能屬性。
- 您可以按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點選「下一步」。
-
在「Authentication」部分中,輸入驗證詳細資料。
- 選取「驗證類型」並輸入相關詳細資料。
Azure AD (Entra ID) 連線支援下列驗證類型:
- Azure AD (授權碼授權類型)
- OAuth 2.0 用戶端憑證
- 使用 JWT 權杖的 OAuth 2.0 用戶端憑證
- 點選「下一步」。
如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。
- 選取「驗證類型」並輸入相關詳細資料。
- 查看:查看連線和驗證詳細資料。
- 按一下 [建立]。
設定驗證機制
根據要使用的驗證方法輸入詳細資料。
-
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 |
使用 JWT 權杖連線類型的 OAuth 2.0 用戶端憑證
欄位名稱 | 詳細資料 |
---|---|
位置 | 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 |
- 建立自行簽署的憑證,並下載私密金鑰憑證和公用金鑰。詳情請參閱「建立自行簽署的憑證」。
- 在 Azure AD 應用程式的「憑證與密鑰」下方,上傳公用金鑰憑證。
- 在私密金鑰欄位中,將私密金鑰憑證值和公開金鑰憑證值同時傳遞至單一密鑰。您不需要為私密金鑰和公開金鑰分別建立機密金鑰。
如要瞭解如何使用 Postman 建立連線,請參閱「使用 API 進行 JWT 連線」一文。
重新授權授權碼
如果您使用 Authorization code
驗證類型,且已在 Azure AD 應用程式中進行任何設定變更,則必須重新授權 Azure AD (Entra ID) 連線。如要重新授權連線,請按照下列步驟操作:
- 在「Connections」頁面中,按一下所需的連線。
系統會開啟連線詳細資料頁面。
- 按一下「編輯」即可編輯連結詳細資料。
- 在「驗證」部分確認「OAuth 2.0 - 授權碼」詳細資料。
視需要進行必要的變更。
- 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
- 在「驗證」部分中,按一下「編輯授權」。畫面上會顯示「Authorize」窗格。
- 按一下「Authorize」。
如果授權成功,連線頁面中的連線狀態就會設為「Active」。
建立連線後的額外步驟
如果您選取 OAuth 2.0 - Authorization code
做為驗證方式,則必須在建立連線後執行下列額外步驟:
- 在「Connections」頁面中,找出新建立的連線。
請注意,新連接器的狀態會是「需要授權」。
- 按一下「需要授權」。
這會顯示「Edit authorization」窗格。
- 將「Redirect URI」值複製到外部應用程式。
- 驗證授權詳細資料。
- 按一下「Authorize」。
如果授權成功,連線頁面中的連線狀態會設為「Active」。
設定事件訂閱
如果您已啟用事件訂閱功能,請在「事件訂閱詳細資料」部分輸入下列值:
- 輸入驗證詳細資料。
- 用戶端 ID:用於要求存取權憑證的用戶端 ID。
- 用戶端密鑰:用於要求存取權存證的用戶端密鑰。
- 密鑰版本:選取密鑰版本。
- 用戶端狀態:包含用戶端狀態的 Secret Manager 密鑰。用於變更通知驗證。
- Azure 用戶群:用於存取資料的 Microsoft Online 用戶群。如果您未指定租用戶,系統會使用預設租用戶。
- 如要將額外資訊附加到後端系統的回應,可視需要選取「啟用資料擴充」。
額外資訊是指您已為其設定事件的實體。詳情請參閱「事件通知中的資料增強功能」。
- 選取「Enable private connectivity」,即可在後端應用程式和連線之間建立安全連線。如果選取這個選項,您必須在建立連線後執行其他設定步驟。詳情請參閱「事件訂閱的私人連線」。
- 輸入死信設定。如果您設定無效信件,連線會將未處理的事件寫入指定的 Pub/Sub 主題。輸入下列詳細資料:
- 死信專案 ID: 您設定死信 Pub/Sub 主題的 Google Cloud 專案 ID。
- 無效信件主題: 您要寫入未處理事件詳細資料的 Pub/Sub 主題。
- 如果您想使用 Proxy 連線至後端 (用於事件訂閱),請輸入下列詳細資料:
- Proxy SSL Type:連線至 Proxy 伺服器時要使用的 SSL 類型。選取下列任一驗證類型:
- 一律:事件訂閱的連線一律會啟用 SSL。
- Never:事件訂閱連線未啟用 SSL。
- Proxy Auth Scheme:選取要用於 Proxy 伺服器驗證的驗證類型。
支援下列驗證類型:
- Basic:基本 HTTP 驗證。
- Proxy User:輸入用於驗證 Proxy 伺服器的使用者名稱。
- Proxy Password:選取使用者密碼的 Secret Manager 密鑰。
- 密鑰版本:選取密鑰版本。
- 在「Proxy 伺服器」部分中,輸入 Proxy 伺服器的詳細資料。
- 按一下「+ 新增目的地」,然後將「目的地類型」設為「主機位址」。
- 輸入 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 (訪客帳戶) 動作
這項操作會將成員從群組中移除
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 | 字串 | 是 | 要新增的目錄物件、使用者或機構聯絡人物件。 |
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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddGroupMember
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3", "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100" }
此動作會傳回 AddGroupMember 的確認訊息。如果動作成功,AddGroupMember
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveGroupMember
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveGroupMember
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3", "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100" }
如果動作成功,RemoveGroupMember
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - AddGroupMember(訪客帳戶)
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddGroupMember
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a", "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100" }
如果動作成功,AddGroupMember
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveGroupMember(Guest Account)
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveGroupMember
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a", "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100" }
如果動作成功,RemoveGroupMember
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - AddUserApplicationRoleAssignment
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddUserApplicationRoleAssignment
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913", "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e", "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217" }
如果動作成功,AddUserApplicationRoleAssignment
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveUserApplicationRoleAssignment
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveUserApplicationRoleAssignment
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913", "AppRoleAssignmentId": "bspYNS4s00GoVL-SSaPJE0xC2--0GxxIu8uS4aeindU" }
如果動作成功,RemoveUserApplicationRoleAssignment
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - AddGroupApplicationRoleAssignment
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddGroupApplicationRoleAssignment
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e", "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217", "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100" }
如果動作成功,AddGroupApplicationRoleAssignment
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveGroupApplicationRoleAssignment
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveGroupApplicationRoleAssignment
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100", "AppRoleAssignmentId": "p3luD3g1tEid3t7Pu3uxAMT7DwI3p29HlrxMuZ143eU" }
如果動作成功,RemoveGroupApplicationRoleAssignment
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例:ActivateDirectoryRole
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
ActivateDirectoryRole
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "RoleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033" }
如果動作成功,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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
VerifyDomain
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Id": "eternalsolarsolutions.com" }
如果動作成功,VerifyDomain
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例:ChangePassword
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
ChangePassword
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "NewPassword": "XXX@9876", "CurrentPassword": "XXX@123" }
如果動作成功,ChangePassword
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - ResetPassword
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
ResetPassword
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Password": "XXX@9876", "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913" }
如果動作成功,ResetPassword
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - AssignLicense
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignLicense
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913", "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com", "AddLicenseSkuId": "6ec92958-3cc1-49db-95bd-bc6b3798df71" }
如果動作成功,AssignLicense
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveLicense
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignLicense
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913", "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com", "RemoveLicenses": "6ec92958-3cc1-49db-95bd-bc6b3798df71" }
如果動作成功,RemoveLicense
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例:FetchAdditionalUserFields
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
FetchAdditionalUserFields
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc" }
如果動作成功,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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddGroupOwner
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100", "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc" }
如果動作成功,AddGroupOwner
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemoveGroupOwner
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveGroupOwner
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100", "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc" }
如果動作成功,RemoveGroupOwner
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例:InviteExternalUser
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
InviteExternalUser
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserEmailAddress": "taleprajyot97@gmail.com", "RedirectURL": "https://www.example.com" }
此動作會傳回「邀請外部使用者」的確認訊息。如果動作成功,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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddPhoneAuthenticationMethod
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "PhoneType": "mobile", "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81", "PhoneNumber": "+91 9898989890" }
如果動作成功,AddPhoneAuthenticationMethod
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RemovePhoneAuthenticationMethod
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemovePhoneAuthenticationMethod
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "PhoneType": "mobile", "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81", "PhoneNumber": "+91 9898989890" }
如果動作成功,RemovePhoneAuthenticationMethod
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - UpdatePhoneAuthenticationMethod
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UpdatePhoneAuthenticationMethod
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "securityComplianceNotificationPhones": "9899999999", "securityComplianceNotificationMails": "abc@gmail.com" }
如果動作成功,UpdatePhoneAuthenticationMethod
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - AddPrivilegedRole
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddPrivilegedRole
動作,然後按一下「Done」。 - 在「Connector」任務的「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}" }
如果動作成功,AddPrivilegedRole
工作項的 connectorOutputPayload
回應參數會具有類似以下的值:
[{ "Success": "True" }]
範例 - RemovePrivilegedRole
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemovePrivilegedRole
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8", "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8", "Justification": "Removing Privileage Role" }
如果動作成功,RemovePrivilegedRole
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Success": "True" }]
範例 - RetrieveUserPhoto
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RetrieveUserPhoto
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "8e22c728-c523-436b-8f46-3b21cc1b5f80" }
如果動作成功,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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UpdateUserPhoto
動作,然後按一下「Done」。 - 在「Connector」任務的「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.]
如果動作成功,UpdateUserPhoto
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例 - RemoveUserPhoto
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveUserPhoto
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc" }
如果動作成功,RemoveUserPhoto
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例 - AssignManager
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignManager
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913", "ObjectId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8", "ObjectName": "users" }
如果動作成功,AssignManager
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "True" }]
範例 - RemoveManager
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveManager
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913" }
如果動作成功,RemoveManager
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "True" }]
範例 - RetrieveManagerChain
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RetrieveManagerChain
動作,然後按一下「Done」。 - 在「Connector」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8", "Levels": "max" }
如果動作成功,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
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AddProfileCardProperty
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Annotations": "[{"displayName": "Attributes"}]", "DirectoryPropertyName": "CustomAttribute15" }
如果動作成功,AddProfileCardProperty
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "True" }]
範例:RemoveProfileCardProperty
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RemoveProfileCardProperty
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "DirectoryPropertyName": "CustomAttribute12" }
如果動作成功,
RemoveProfileCardProperty
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "True" }]
實體操作範例
本節說明如何在這個連接器中執行部分實體作業。
範例:列出群組
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「群組」。 - 選取
LIST
作業,然後按一下「Done」。 - 在「連接器」工作中的「任務輸入」部分,您可以根據客戶需求設定filterClause。
您必須使用單引號 (') 括住篩選器子句的值。您可以使用篩選子句,根據資料欄篩選記錄。
您也可以對下列實體執行 LIST 作業:
- 使用者
- GroupMembers
- 網域
- RoleAssignments
- 應用程式
- 裝置
- 聯絡人
- DirectoryRoleTemplates
- DirectoryRoles
- AdministrativeUnits
- SubscribedSKUs
- PhoneAuthenticationMethod
- 機構
- DeviceLocalCredentials
- ProfileCardProperties
範例:從群組中取得單一記錄
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「群組」。 - 選取
GET
作業,然後按一下「Done」。 - 將實體 ID 設為「bb4756c7-38c0-426b-97aa-03b6443e7f16」,這是要傳遞的 Key。如要設定實體 ID,請在「資料對應」的「資料對應」專區中,按一下「開啟資料對應編輯器」,然後在「輸入值」欄位中輸入
"bb4756c7-38c0-426b-97aa-03b6443e7f16"
,並選擇「EntityId」做為「Local」變數。
您也可以對下列實體執行 GET 作業:
- 使用者
- GroupMembers
- 網域
- RoleAssignments
- 應用程式
- 裝置
- 聯絡人
- DirectoryRoleTemplates
- DirectoryRoles
- AdministrativeUnits
- PhoneAuthenticationMethod
- 機構
- UserManagers
- DeviceLocalCredentials
範例:從群組中刪除記錄
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「群組」。 - 選取
DELETE
作業,然後按一下「Done」。 - 將實體 ID 設為「62008bbe-effa-4341-9d29-eac7f67b84fe」,這是要傳遞的鍵。如要設定實體 ID,請在「資料對應」的「資料對應」專區中,按一下「開啟資料對應編輯器」,然後在「輸入值」欄位中輸入
"62008bbe-effa-4341-9d29-eac7f67b84fe"
,並選擇「EntityId」做為「Local」變數。如果有兩個複合式或主鍵,則傳遞實體 ID 可能會擲回錯誤。在這種情況下,您可以使用篩選器子句,例如
id='62008bbe-effa-4341-9d29-eac7f67b84fe'
。
您也可以對下列實體執行 DELETE 作業:
範例:建立群組 (Microsoft 365) 實體
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「群組」。 - 選取
Create
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
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" }
範例:更新使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「使用者」。 - 選取
Update
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分中,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為「Local」變數。{ "jobTitle": "Software Engineer" }
- 將 Data Mapper 中的實體 ID 設為 Users 實體。如要設定實體 ID,請按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為區域變數。或者,您也可以將 entityId 設為
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 中建立及使用連接器工作,請參閱「連接器工作」。