AD Local

Provides integration with Microsoft Active Directory using protected LDAP v3 operations from a Local Runtime.

Revision History

0.0.0.4 - Initial release.

Connection

Use this Connection to store the Active Directory base distinguished name (DN) and credentials used by all methods.

Property	Type	Description
`Base DN`	String	Domain root or descendant OU or container DN. The Node uses this value as the default query base and derives the DNS domain from its `DC=` components.
`Username`	String	Qualified Active Directory account in `user@domain` or `DOMAIN\user` format.
`Password`	Masked	Password for the qualified Active Directory account.

Setup Notes

Run this Node on a Windows-hosted Local Runtime with DNS and TCP LDAP access to the Active Directory domain.
Set Base DN to the domain root or an OU or container beneath it, e.g. OU=Integration,DC=corp,DC=example,DC=com. The DN must contain at least one DC= component.
Use a qualified Username in either user principal name format, e.g. integration@corp.example.com, or down-level logon format, e.g. CORP\integration.
Grant the account only the permissions required by the queries and changes in your Workflow.
Test the Connection after configuring it. The connection test performs a base-scope search against Base DN and expects exactly one directory entry.
The Node uses Negotiate authentication with LDAP signing and sealing. Referral chasing is disabled.

Methods

The Node exposes methods to query, create, update, delete, rename, and move Active Directory objects.

Query

Searches Active Directory using an exact LDAP search base, RFC 4515 filter, search scope, and structured attribute list.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`SearchBaseDn`	String	Exact DN from which to start the search. Leave this empty to use `Base DN` from the `Connection`.
`Filter`	String	Exact RFC 4515 LDAP filter, e.g. `(objectClass=user)`.
`Scope`	AD Local Search Scope	Search traversal scope. Select `Base`, `One Level`, or `Subtree`.
`Attributes`	Array	One or more exact LDAP attribute names to return. See `Query Attribute Properties` below.

Return	Type	Description
`Response`	Array	One row per matching directory entry. See `Query Response Properties` below.

Query Attribute Properties

Property	Type	Description
`Name`	String	Exact LDAP attribute name or supported selector such as `*`.

Query Response Properties

Property	Type	Description
`DistinguishedName`	String	Exact DN returned by Active Directory.
`Attributes`	Array	Attributes returned for the directory entry. See `Directory Attribute Properties` under `Usage Notes`.

Create

Creates schema-valid Active Directory objects from structured attributes.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`Items`	Array	Objects to create. Each item must contain `DistinguishedName` and `Attributes`.

Return	Type	Description
`Response`	Array	One result row per connected item. See `Mutation Response Properties` under `Usage Notes`.

Create Item Properties

Property	Type	Description
`DistinguishedName`	String	Exact DN of the object to create.
`Attributes`	Array	One or more structured LDAP attributes. The collection must include `objectClass`, and every attribute must contain at least one value.

Update

Applies ordered Add, Replace, or Delete attribute changes atomically to each directory object.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`Items`	Array	Objects to update. Each item must contain `DistinguishedName` and one or more `Changes`.

Return	Type	Description
`Response`	Array	One result row per connected item. See `Mutation Response Properties` under `Usage Notes`.

Update Item Properties

Property	Type	Description
`DistinguishedName`	String	Exact DN of the object to update.
`Changes`	Array	Ordered attribute modifications. See `Change Properties` below.

Change Properties

Property	Type	Description
`Operation`	String	Operation to apply. Enter exactly `Add`, `Replace`, or `Delete`.
`Name`	String	Exact LDAP attribute name.
`Values`	Array	Directory values for the change. `Add` and `Replace` require at least one value. Omit this Property or use an empty collection with `Delete` to remove the complete attribute.

Delete

Deletes one Active Directory object for each connected item.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`Items`	Array	Objects containing the exact `DistinguishedName` to delete.

Return	Type	Description
`Response`	Array	One result row per connected item. See `Mutation Response Properties` under `Usage Notes`.

Delete Item Properties

Property	Type	Description
`DistinguishedName`	String	Exact DN of the object to delete. The Node does not perform recursive tree deletion.

Rename

Changes an object's relative distinguished name (RDN) without moving it to another parent.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`Items`	Array	Objects containing `DistinguishedName` and `NewRelativeDistinguishedName`.

Return	Type	Description
`Response`	Array	One result row per connected item. A successful row contains the resulting DN. See `Mutation Response Properties` under `Usage Notes`.

Rename Item Properties

Property	Type	Description
`DistinguishedName`	String	Exact current DN of the object.
`NewRelativeDistinguishedName`	String	One exact new RDN without a parent DN, e.g. `CN=New Name`. The old naming value is removed.

Move

Moves an object to another OU or container in the same Active Directory domain without renaming it.

Parameter	Type	Description
`Connection`	Connection	AD Local Connection details.
`Items`	Array	Objects containing `DistinguishedName` and `NewParentDistinguishedName`.

Return	Type	Description
`Response`	Array	One result row per connected item. A successful row contains the resulting DN. See `Mutation Response Properties` under `Usage Notes`.

Move Item Properties

Property	Type	Description
`DistinguishedName`	String	Exact current DN of the object.
`NewParentDistinguishedName`	String	Exact destination OU or container DN in the same domain.

Usage Notes

Method templates provide structured examples without contacting Active Directory. Review and replace all placeholder DNs before running a destructive method.
Query requires at least one Attributes item and preserves the exact filter and attribute names you supply.
Query handles LDAP paging internally in pages of up to 500 entries.
Query responses contain provider-shaped directory data and do not include mutation-style Flowgear metadata.
Create, Update, Delete, Rename, and Move process one connected Items object at a time and return one response row for each processed item.
A validation or directory operation failure on the first mutation item stops the method. A handled failure on a later item returns Flowgear.IsSuccess as false, then processing continues with the next item. Connection failures and cancellation stop the method.
Attribute values use explicit Type and Value fields. Set Type to exactly String for text or Base64 for binary data.

Directory Attribute Properties

Create items and Query responses use the same structured directory attribute shape.

Property	Type	Description
`Name`	String	Exact LDAP attribute name.
`Values`	Array	Ordered directory values. See `Directory Value Properties` below.

Directory Value Properties

Property	Type	Description
`Type`	String	Value type. Enter exactly `String` or `Base64`.
`Value`	String	Exact LDAP text value or Base64-encoded binary value.

Mutation Response Properties

Mutation methods return the following fields:

Property	Type	Description
`DistinguishedName`	String	Requested DN, or the resulting DN after a successful `Rename` or `Move`.
`ProviderResultCode`	String	LDAP result code returned for a successful operation.
`Flowgear`	Object	Per-item status and request details. See `Flowgear Properties` below.
`ProviderError`	Object	Provider or validation details for a handled failed item. See `Provider Error Properties` below.

Flowgear Properties

Property	Type	Description
`IsSuccess`	Boolean	Indicates whether the directory item completed successfully.
`Message`	String	Concise success or handled failure detail.
`Request`	Object	Copy of the connected `Items` object that produced this response row.

Provider Error Properties

Property	Type	Description
`ResultCode`	String	LDAP result code, or `ValidationError` for an invalid connected item.
`ErrorCode`	Integer	Native LDAP error code when available.
`Message`	String	Provider or validation diagnostic.
`MatchedDistinguishedName`	String	Matched DN when Active Directory returns one.

Examples

Query Attributes

Request two attributes from each matching entry:

[
  {
    "Name": "distinguishedName"
  },
  {
    "Name": "objectClass"
  }
]

Create Item

Create an organizational unit:

{
  "DistinguishedName": "OU=Integration,DC=corp,DC=example,DC=com",
  "Attributes": [
    {
      "Name": "objectClass",
      "Values": [
        {
          "Type": "String",
          "Value": "organizationalUnit"
        }
      ]
    },
    {
      "Name": "ou",
      "Values": [
        {
          "Type": "String",
          "Value": "Integration"
        }
      ]
    }
  ]
}

Update Item

Apply ordered attribute changes:

{
  "DistinguishedName": "CN=Sample User,OU=Integration,DC=corp,DC=example,DC=com",
  "Changes": [
    {
      "Operation": "Add",
      "Name": "description",
      "Values": [
        {
          "Type": "String",
          "Value": "Integration account"
        }
      ]
    },
    {
      "Operation": "Replace",
      "Name": "displayName",
      "Values": [
        {
          "Type": "String",
          "Value": "Sample Integration User"
        }
      ]
    },
    {
      "Operation": "Delete",
      "Name": "obsoleteAttribute",
      "Values": []
    }
  ]
}

Known Issues

Large multivalued attributes may be returned with range-qualified names such as member;range=0-1499. The Node preserves these names but does not automatically retrieve later ranges.
The Connection does not expose server, port, LDAPS, or referral settings. The Node discovers the domain from Base DN and uses protected Negotiate authentication.