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.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, seeAction examples.

For example on how to configure theMoveToDN action,seeAction examples.

GetAttributes action

This action gets attributes of the specified object.

Input parameters of the GetAttributes action

For example on how to configure theGetAttributes action,seeAction examples.

AddMembersToGroup action

This action adds members to a group.

Input parameters of the AddMembersToGroup action

For example on how to configure theAddMembersToGroup action,seeAction examples.

RemoveMembersFromGroup action

This action removes members from a group.

Input parameters of the RemoveMembersFromGroup action

For example on how to configure theRemoveMembersFromGroup action,seeAction examples.

ResetPassword action

This action resets password.

Input parameters of the ResetPassword action

For example on how to configure theResetPassword action,seeAction examples.

ChangePassword action

This action changes password.

Input parameters of the ChangePassword action

For example on how to configure theChangePassword action,seeAction examples.

Action examples

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

Example - Move an object from one DN to another

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:

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

If the action is successful, theMoveToDN task'sconnectorOutputPayload responseparameter 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=admin,CN=Users,DC=test-ldap,DC=com"}

If the action is successful, theGetAttributes task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Add members 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=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\"}]"}

If the action is successful, theAddMembersToGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"Success": "True"}]

Example - Remove members from a group

1. In theConfigure connector task dialog, clickActions.
2. Select theRemoveMembersFromGroup 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=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\"}]"}

If the action is successful, theRemoveMembersFromGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"Success": "True"}]

Example - Reset password

1. In theConfigure connector task dialog, clickActions.
2. Select theResetPassword 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:

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

If the action is successful, theResetPassword task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Change password

1. In theConfigure connector task dialog, clickActions.
2. Select theChangePassword 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:

   {"NewPassword": "XXXX"}

If the action is successful, theChangePassword task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all Users

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theList operation, and then clickDone.
4. Optionally, inTask Input section of theConnectors task, you canfilter your result set by specifying afilter clause.Specify the filter clause value always within the single quotes (').

You can perform List operation on the following entities:

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

Example - Get a User record

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 andthen enter1|CN=Active Directory User,DC=test-ldap,DC=com in theDefault Value field.

   Here,41|CN=Active Directory User,DC=test-ldap,DC=com is a unique record ID in theUser entity.

You can perform Get operation on the following entities:

Group, User Membership, Group Membership, OrganizationalPerson, Person, Top, SecurityPrincipal, Organization, OrganizationalRole, DomainPolicy, Contact, Computer, DnsNode, SecurityObject, OrganizationalUnit, Domain, and Account

If your entity has a composite primary key, you can specify afilter clause.

Example - Create a User record

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= Active Directory User ","ObjectClass": "top;person;organizationalPerson;user"}

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Create a Computer record

1. In theConfigure connector task dialog, clickEntities.
2. SelectComputer from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theComputer task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Group (DomainLocal) record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Group (Global) record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Group (Universal) record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Group (Universal Security) record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theGroup task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a OrganizationPerson record

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrganizationPerson from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theOrganizationPerson task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Person record

1. In theConfigure connector task dialog, clickEntities.
2. SelectPerson from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, thePerson task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Create a Top record

1. In theConfigure connector task dialog, clickEntities.
2. SelectTop from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, theTop task'sconnectorOutputPayload responseparameter will have a value similar to the following:

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

Example - Update a User record

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": "560048"}

Instead of specifying theentityId, you can also set thefilterClause to 1|CN=Active Directory User,DC=test-ldap,DC=com.

Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a Group record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

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

   Instead of specifying theentityId, you can also set thefilterClause to1|CN=ADGroup9bff,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a Group (GroupType) record

1. In theConfigure connector task dialog, clickEntities.
2. SelectGroup from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   { "GroupType": "4"}

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

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a OrganizationPerson record

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrganizationPerson from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {  "Title": "Test Engineer"}

   Instead of specifying theentityId, you can also set thefilterClause to1|CN=OrgP_ADa022f,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a Person record

1. In theConfigure connector task dialog, clickEntities.
2. SelectPerson from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {  "TelephoneNumber": "7764942992"}

   Instead of specifying theentityId, you can also set thefilterClause to1|CN=Person2e6,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a Top record

1. In theConfigure connector task dialog, clickEntities.
2. SelectTop from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {  "Description": "Top Testing GOOGLECLOUD"}

   Instead of specifying theentityId, you can also set thefilterClause to1|CN=Top3b6bc,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Update a Computer record

1. In theConfigure connector task dialog, clickEntities.
2. SelectComputer from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theData Mapper section of theData Mapping task, clickOpen Data Mapping Editor and then enter a value similar to the following in theInput Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

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

   Instead of specifying theentityId, you can also set thefilterClause to1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local.

   Running this example, returns a response similar to the following in the connectortask'sconnectorOutputPayload output variable:

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

Example - Delete a User record

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=Active Directory User,DC=test-ldap,DC=com in theDefault Value field.

You can perform Delete operation on the following entities:

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

If your entity has a composite primary key, you can specifyafilter clause.