LDAP

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このセクションでは、LDAP コネクタでサポートされているすべてのアクションを一覧表示します。

MoveToDN アクション

このアクションは、オブジェクトをある DN（識別名）から別の DN に移動します。

MoveToDN アクションの入力パラメータ

DownloadFile アクションの出力パラメータ

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

MoveToDN アクションの構成方法については、アクションの例をご覧ください。

GetAttributes アクション

このアクションは、DN のすべての属性名と値を取得します。

GetAttributes アクションの入力パラメータ

GetAttributes アクションの出力パラメータ

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

GetAttributes アクションの構成方法については、アクションの例をご覧ください。

AddMembersToGroup アクション

このアクションでは、ユーザーをグループに追加します。

GetAttributes アクションの入力パラメータ

AddMembersToGroup アクションの出力パラメータ

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

AddMembersToGroup アクションの構成方法については、アクションの例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - オブジェクトを 1 つの DN から別の DN に移動する

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [MoveToDN] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "DN": "CN=Google Cloud,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com",
   "NewParentDN": "OU=Mysore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
   }
     

この例では、オブジェクトをある DN から別の DN に移動します。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

例 - DN の属性を取得する

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [GetAttributes] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "DN": "CN=Bangalore user,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
   }

この例では、指定した DN の属性を取得します。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
    "AttributeName": "_op",
    "AttributeValue": "ldapadoGetAttributes"
  }, {
    "AttributeName": "usncreated",
    "AttributeValue": "36006"
  }, {
    "AttributeName": "countrycode",
    "AttributeValue": "0"
  }, {
    "AttributeName": "badpwdcount",
    "AttributeValue": "0"
  }, {
    "AttributeName": "dn",
    "AttributeValue": ""
  }, {
    "AttributeName": "dn",
    "AttributeValue": "CN=Bangalore user,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
  }, {
    "AttributeName": "whenchanged",
    "AttributeValue": "20230913125155.0Z"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "top"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "person"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "organizationalPerson"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "user"
  }, {
    "AttributeName": "primarygroupid",
    "AttributeValue": "513"
  }, {
    "AttributeName": "givenname",
    "AttributeValue": "Bangalore"
  }, {
    "AttributeName": "dscorepropagationdata",
    "AttributeValue": "16010101000001.0Z"
  }, {
    "AttributeName": "sn",
    "AttributeValue": "user"
  }, {
    "AttributeName": "useraccountcontrol",
    "AttributeValue": "512"
  }, {
    "AttributeName": "cn",
    "AttributeValue": "Bangalore user"
  }, {
    "AttributeName": "codepage",
    "AttributeValue": "0"
  }, {
    "AttributeName": "accountexpires",
    "AttributeValue": "9223372036854775807"
  }, {
    "AttributeName": "userprincipalname",
    "AttributeValue": "user-1@test-l
  }]  
  

例 - グループにユーザーを追加する

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [AddMembersToGroup] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "GroupId": "1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com",
   "UserDNs": "[{\"DN\":\"CN=Google AI,CN=Users,DC=test-ldap,DC=com;CN=Guest,CN=Users,DC=test-ldap,DC=com\"}]"
   }

この例では、ID が 1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com のグループにユーザー DN を追加します。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
  "Success": "True"
  }]

エンティティ オペレーションの例

例 - ユーザーを一覧表示する

この例では、User エンティティ内のすべてのユーザーを一覧表示します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [LIST] オペレーションを選択してから、[完了] をクリックします。
4. 必要に応じて、結果セットをフィルタリングできます。結果セットをフィルタリングするには、[コネクタ] タスクの [タスク入力] セクションで、要件ごとに filterClause を設定します。

   たとえば、フィルタ句を Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com' に設定すると、ID がこの条件に一致するレコードのみが一覧表示されます。

例 - ユーザー レコードを取得する

この例では、User エンティティからユーザーの詳細を取得します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [GET] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに 1|CN=admin,CN=Users,DC=test-ldap,DC=com を入力します。

   ここで、1|CN=admin,CN=Users,DC=test-ldap,DC=com は User エンティティの主キー値の 1 つです。

例 - ユーザー レコードを作成する

この例では、User エンティティにユーザー レコードを作成します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [Create] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

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

   統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

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

例 - チケットを更新する

この例では、User エンティティで指定されたユーザー レコードを更新します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [Update] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
           "PostalCode": "560040"
         }
         

5. [entityId] をクリックし、[デフォルト値] フィールドに「1|CN=admin,CN=Users,DC=test-ldap,DC=com」と入力します。

   [entityId] を指定する代わりに、[filterClause] を 1|CN=admin,CN=Users,DC=test-ldap,DC=com に設定することもできます。

   統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

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

例 - ユーザー レコードを削除する

この例では、User エンティティからユーザー レコードを削除します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [Delete] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに「1|CN=admin,CN=Users,DC=test-ldap,DC=com」と入力します。
5. または、User エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。例: Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com' and DN='CN=admin,CN=Users,DC=test-ldap,DC=com'