Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects ofthe connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity:An entity can be thought of as an object, or a collection of properties, in theconnected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case theEntities list will be empty.

• Operation:An operation is the activity that you can perform on an entity. You can performany of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list ofoperations available for the entity. For a detailed description of the operations, see the Connectors task'sentity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in theOperations list.

• Action:An action is a first class function that is made available to the integrationthrough the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case theActions list will be empty.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Move an object from one DN to another DN

1. In theConfigure connector task dialog, clickActions.
2. Select theMoveToDN action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"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"}

This example moves an object from one DN to another DN. If the action is successful, your connector task'sconnectorOutputPayload response parameter will have a value similar to the following:

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

Example - Get attributes of a DN

1. In theConfigure connector task dialog, clickActions.
2. Select theGetAttributes action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

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

This example gets the attribute of the specified DN. If the action is successful, your connector task'sconnectorOutputPayload response parameter will have a value similar to the following:

[{"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  }]

Example - Add users to a group

1. In theConfigure connector task dialog, clickActions.
2. Select theAddMembersToGroup action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"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\"}]"}

This example adds a user DN to the group with ID1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com. If the action is successful, your connector task'sconnectorOutputPayload response parameter will have a value similar to the following:

[{"Success":"True"}]

Entity operation examples

Example - List users

This example lists all the users in theUser entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theLIST operation, and then clickDone.
4. Optionally, you can filter the result set. To filter the result set, in theTask Input section of theConnectors task, set thefilterClause as per your requirement.

   For example, setting the filter clause toId='1|CN=admin,CN=Users,DC=test-ldap,DC=com', lists only those records whose Id matches this criteria.

Example - Get a user record

This example gets a user detail from theUser entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theGET operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickEntityId and then enter1|CN=admin,CN=Users,DC=test-ldap,DC=com in theDefault Value field.

   Here,1|CN=admin,CN=Users,DC=test-ldap,DC=com is one of the primary key values of theUser entity.

Example - Create a user record

This example creates a user record in theUser entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

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

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

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

Example - Update a ticket

This example updates the specified user record in theUser entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"PostalCode":"560040"}

5. ClickentityId, and then enter1|CN=admin,CN=Users,DC=test-ldap,DC=com in theDefault Value field.

   Alternately, instead of specifying theentityId, you can also set thefilterClause to1|CN=admin,CN=Users,DC=test-ldap,DC=com.

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

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

Example - Delete a user record

This example deletes a user record from theUser entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theDelete operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId and then enter1|CN=admin,CN=Users,DC=test-ldap,DC=com in theDefault Value field.
5. Alternately, ifUser entity has composite primary keys, instead of specifying theentityId, you can set thefilterClause. For example,Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com' and DN='CN=admin,CN=Users,DC=test-ldap,DC=com'.