Active Directory

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the 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 the connected 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 the Entities list will be empty.

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

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

• Action: An action is a first class function that is made available to the integration through 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 the Actions list will be empty.

Actions

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

MoveToDN action

This action moves an object from one DN to another.

Input parameters of the MoveToDN action

For example on how to configure the MoveToDN action, see Action examples.

GetAttributes action

This action gets attributes of the specified object.

Input parameters of the GetAttributes action

For example on how to configure the GetAttributes action, see Action examples.

AddMembersToGroup action

This action adds members to a group.

Input parameters of the AddMembersToGroup action

For example on how to configure the AddMembersToGroup action, see Action examples.

RemoveMembersFromGroup action

This action removes members from a group.

Input parameters of the RemoveMembersFromGroup action

For example on how to configure the RemoveMembersFromGroup action, see Action examples.

ResetPassword action

This action resets password.

Input parameters of the ResetPassword action

For example on how to configure the ResetPassword action, see Action examples.

ChangePassword action

This action changes password.

Input parameters of the ChangePassword action

For example on how to configure the ChangePassword action, see Action 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 the Configure connector task dialog, click Actions.
2. Select the MoveToDN action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the MoveToDN task's connectorOutputPayload 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 the Configure connector task dialog, click Actions.
2. Select the GetAttributes action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the GetAttributes task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Actions.
2. Select the AddMembersToGroup action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default 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, the AddMembersToGroup task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True"
}] 

Example - Remove members from a group

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveMembersFromGroup action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default 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, the RemoveMembersFromGroup task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True"
}]

Example - Reset password

1. In the Configure connector task dialog, click Actions.
2. Select the ResetPassword action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default 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, the ResetPassword task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Change password

1. In the Configure connector task dialog, click Actions.
2. Select the ChangePassword action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "NewPassword": "XXXX"
   }
   

If the action is successful, the ChangePassword task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter 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 the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 1|CN=Active Directory User,DC=test-ldap,DC=com in the Default Value field.

   Here, 41|CN=Active Directory User,DC=test-ldap,DC=com is a unique record ID in the User 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

Example - Create a User record

1. In the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Create a Computer record

1. In the Configure connector task dialog, click Entities.
2. Select Computer from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Computer task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Group task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Group task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Group task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Group task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select OrganizationPerson from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input 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, the OrganizationPerson task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Person from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Person task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select Top from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

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

   If the integration is successful, the Top task's connectorOutputPayload response parameter 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 the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "PostalCode": "560048"
   }

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

Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a Group record

1. In the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input 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 the entityId, you can also set the filterClause to 1|CN=ADGroup9bff,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a Group (GroupType) record

1. In the Configure connector task dialog, click Entities.
2. Select Group from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
    "GroupType": "4"
   }
   

   Instead of specifying the entityId, you can also set the filterClause to 1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a OrganizationPerson record

1. In the Configure connector task dialog, click Entities.
2. Select OrganizationPerson from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
     "Title": "Test Engineer"
   }
   

   Instead of specifying the entityId, you can also set the filterClause to 1|CN=OrgP_ADa022f,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a Person record

1. In the Configure connector task dialog, click Entities.
2. Select Person from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
     "TelephoneNumber": "7764942992"
   }
   

   Instead of specifying the entityId, you can also set the filterClause to 1|CN=Person2e6,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a Top record

1. In the Configure connector task dialog, click Entities.
2. Select Top from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
     "Description": "Top Testing GOOGLECLOUD"
   }
   

   Instead of specifying the entityId, you can also set the filterClause to 1|CN=Top3b6bc,DC=test-ldap,DC=com.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Update a Computer record

1. In the Configure connector task dialog, click Entities.
2. Select Computer from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

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

   Instead of specifying the entityId, you can also set the filterClause to 1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

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

Example - Delete a User record

1. In the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 1|CN=Active Directory User,DC=test-ldap,DC=com in the Default 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