Active Directory

實體、作業和動作

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

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

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

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

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

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

動作

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

MoveToDN 動作

這項動作會將物件從一個 DN 移至另一個 DN。

MoveToDN 動作的輸入參數

如要瞭解如何設定 MoveToDN 動作，請參閱「動作範例」。

GetAttributes 動作

這項動作會取得指定物件的屬性。

GetAttributes 動作的輸入參數

如要瞭解如何設定 GetAttributes 動作，請參閱「動作範例」。

AddMembersToGroup 動作

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

AddMembersToGroup 動作的輸入參數

如要瞭解如何設定 AddMembersToGroup 動作，請參閱「動作範例」。

RemoveMembersFromGroup 動作

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

RemoveMembersFromGroup 動作的輸入參數

如要瞭解如何設定 RemoveMembersFromGroup 動作，請參閱「動作範例」。

ResetPassword 動作

這項操作會重設密碼。

ResetPassword 動作的輸入參數

如要瞭解如何設定 ResetPassword 動作，請參閱「動作範例」。

ChangePassword 動作

這項操作會變更密碼。

ChangePassword 動作的輸入參數

如要瞭解如何設定 ChangePassword 動作，請參閱「動作範例」。

動作範例

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

範例 - 將物件從一個 DN 移至另一個 DN

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 MoveToDN 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "NewParentDN": "CN=Users,DC=gcpad,DC=local",
   "DN": "CN=GoogleAdmin,CN=Computers,DC=gcpad,DC=local"
   }

如果動作成功，MoveToDN 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": null,
"result": "[ok]",
"modified": "true",
"rss:title": "The movement was successful.",
"resultcode": "0"
}]

範例 - 取得 DN 的屬性

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 GetAttributes 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "DN": "CN=admin,CN=Users,DC=test-ldap,DC=com"
   } 
   

如果動作成功，GetAttributes 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"AttributeName": "_op",
"AttributeValue": "ldapadoGetAttributes"
},
{
"AttributeName": "msds-supportedencryptiontypes",
"AttributeValue": "24"
},
{
"AttributeName": "usncreated",
"AttributeValue": "12775"
},
{
"AttributeName": "objectclass",
"AttributeValue": "organizationalPerson"
},
{
"AttributeName": "objectclass",
"AttributeValue": "user"
},
{
"AttributeName": "accountexpires",
"AttributeValue": "9223372036854775807"
},
{
"AttributeName": "name",
"AttributeValue": "admin"
},
{
"AttributeName": "objectcategory",
"AttributeValue": "CN=Person,CN=Schema,CN=Configuration,DC=test-ldap,DC=com"
},
{
"AttributeName": null,
"AttributeValue": null
}] 

範例 - 將成員新增至群組

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AddMembersToGroup 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "GroupId": "1|CN=GoogleGRP1fa2,CN=Users,DC=gcpad,DC=local",
   "UserDNs": "[{\"DN\":\"CN=GoogleAI,CN=Users,DC=gcpad,DC=local;CN=Guest,CN=Users,DC=gcpad,DC=local\"}]"
   }
   

如果動作成功，AddMembersToGroup 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "True"
}] 

範例 - 從群組中移除成員

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 RemoveMembersFromGroup 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "GroupId": "1|CN=GoogleGRP1fa2,CN=Users,DC=gcpad,DC=local",
   "UserDNs": "[{\"DN\":\"CN=GoogleAI,CN=Users,DC=gcpad,DC=local;CN=Guest,CN=Users,DC=gcpad,DC=local\"}]"
   }
   

如果動作成功，RemoveMembersFromGroup 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "True"
}]

範例 - 重設密碼

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ResetPassword 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "AdminPassword": "XXXX=",
   "User": "CN=GCP_Admin,CN=Users,DC=gcpad,DC=local",
   "NewPassword": "XXXX",
   "AdminUser": "CN=admin,CN=Users,DC=gcpad,DC=local"
   }
   

如果動作成功，ResetPassword 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true",
"result": "[ok]",
"rss:title": "Password modified successfully",
"resultcode": "0"
}]

範例 - 變更密碼

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ChangePassword 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "NewPassword": "XXXX"
   }
   

如果動作成功，ChangePassword 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true",
"result": "[ok]",
"rss:title": "Password modified successfully.",
"resultcode": "0"
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有使用者

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 User。
3. 選取「List」作業，然後按一下「完成」。
4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。 請一律在單引號 (') 內指定篩選子句值。

您可以對下列實體執行 List 作業：

Group、User Membership、Group Membership、OrganizationalPerson、Person、Top、Organization、OrganizationalRole、DomainPolicy、Contact、Computer、DnsNode、SecurityObject、OrganizationalUnit、Domain 和 Account

範例 - 取得使用者記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 User。
3. 選取「Get」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 1|CN=Active Directory User,DC=test-ldap,DC=com。

   其中 41|CN=Active Directory User,DC=test-ldap,DC=com 是 User 實體中的專屬記錄 ID。

您可以對下列實體執行 Get 作業：

群組、使用者成員資格、群組成員資格、OrganizationalPerson、Person、Top、SecurityPrincipal、Organization、OrganizationalRole、DomainPolicy、Contact、Computer、DnsNode、SecurityObject、OrganizationalUnit、Domain 和 Account

範例 - 建立使用者記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 User。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "RDN": "CN= Active Directory User ",
   "ObjectClass": "top;person;organizationalPerson;user"
   }

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=Administrator,CN=Users,DC=test-ldap,DC=com"
   }

範例 - 建立電腦記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Computer。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
   "RDN": "CN=DELVM04S03",
   "ObjectClass": "top;person;organizationalPerson;user;computer"
   } 
   

   如果整合成功，Computer 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
   "Id": "1|CN=DELVM04S03,CN=Computers,DC=gcpad,DC=local"
   }
   

範例 - 建立群組 (DomainLocal) 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
   "RDN": "CN=DomainLocala496",
   "ObjectClass": "group",
   "GroupType": "4"
   }
   

   如果整合成功，Group 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=DomainLocala496,CN=Users,DC=test-ldap,DC=com"
   }
   

範例 - 建立群組 (全域) 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=Globalf862",
     "ObjectClass": "group",
     "GroupType": "-2147483646"
   }
   

   如果整合成功，Group 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=Globalf862,CN=Users,DC=test-ldap,DC=com"
   }
   

範例 - 建立 Group (Universal) 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=UniversalGRP20e5",
     "ObjectClass": "group",
     "GroupType": "8"
   }
   

   如果整合成功，Group 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com"
   }
   

範例 - 建立群組 (通用安全性) 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=UniversalSecurity3f5a",
     "ObjectClass": "group",
     "GroupType": "-2147483640"
   }
   

   如果整合成功，Group 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=UniversalSecurity3f5a,CN=Users,DC=test-ldap,DC=com"
   }
   

範例 - 建立 OrganizationPerson 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 OrganizationPerson。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=OrgP_AD45237",
     "ObjectClass": "top;person;organizationalPerson;user;inetOrgPerson"
   }
   

   如果整合成功，OrganizationPerson 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=OrgP_AD45237,CN=Users,DC=gcpad,DC=local"
   }
   

範例 - 建立人員記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Person。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=Personc3a",
     "ObjectClass": "top;person;organizationalPerson;user"
   }
   

   如果整合成功，Person 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=Personc3a,CN=Users,DC=gcpad,DC=local"
   } 
   

範例 - 建立 Top 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Top。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload 做為本機變數。

   {
     "RDN": "CN=Top49b88",
     "ObjectClass": "top;person;organizationalPerson;user;inetOrgPerson"
   }
   

   如果整合成功，Top 工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
     "Id": "1|CN=Top49b88,CN=Users,DC=gcpad,DC=local"
   }
   

範例 - 更新使用者記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 User。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "PostalCode": "560048"
   }

除了指定 entityId，您也可以將 filterClause 設為 1|CN=Active Directory User,DC=test-ldap,DC=com。

執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

{
"Id": "1|CN=Active Directory User,DC=test-ldap,DC=com"
}

範例 - 更新群組記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
     "Member": "CN=admin,CN=Users,DC=test-ldap,DC=com;CN=Administrator,CN=Users,DC=test-ldap,DC=com"
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=ADGroup9bff,DC=test-ldap,DC=com。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=ADGroup9bff,DC=test-ldap,DC=com"
   }
   

範例 - 更新群組 (GroupType) 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Group。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
    "GroupType": "4"
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com"
   }
   

範例 - 更新 OrganizationPerson 記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 OrganizationPerson。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
     "Title": "Test Engineer"
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=OrgP_ADa022f,DC=test-ldap,DC=com。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=OrgP_ADa022f,DC=test-ldap,DC=com"
   }
   

範例 - 更新人員記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Person。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
     "TelephoneNumber": "7764942992"
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=Person2e6,DC=test-ldap,DC=com。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=Person2e6,DC=test-ldap,DC=com"
   }
   

範例 - 更新頂端記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Top。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
     "Description": "Top Testing GOOGLECLOUD"
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=Top3b6bc,DC=test-ldap,DC=com。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=Top3b6bc,DC=test-ldap,DC=com"
   }
   

範例 - 更新電腦記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Computer。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

   {
   "Description": "This is Windows 2019 Server."
   }
   

   除了指定 entityId，您也可以將 filterClause 設為 1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local。

   執行這個範例後，連接器工作 connectorOutputPayload 輸出變數會傳回類似以下的回應：

   {
   "Id": "1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local"
   }
   

範例 - 刪除使用者記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 User。
3. 選取「Delete」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下「entityId」，然後在「Default Value」(預設值) 欄位中輸入 1|CN=Active Directory User,DC=test-ldap,DC=com。

您可以對下列實體執行刪除作業：

Group、User Membership、Group Membership、OrganizationalPerson、Person、Top、Organization、OrganizationalRole、DomainPolicy、Contact、Computer、DnsNode、SecurityObject、OrganizationalUnit、Domain 和 Account