Neo4j Find User by External ID
AI-generatedOverview
This node connects to a Neo4j graph database and searches for a user node based on a provided External ID. It is designed to find and return detailed information about a user identified uniquely by their external identifier.
Common scenarios where this node is beneficial include:
- Integrating user data from external systems into workflows.
- Enriching workflow data with user details stored in a Neo4j database.
- Validating the existence of a user before performing further operations.
For example, you might use this node to fetch user profile information during an automation that synchronizes user accounts between different platforms.
Properties
| Name | Meaning |
|---|---|
| External ID | The unique external identifier of the user to find in the Neo4j database. This is a required string input. |
Output
The node outputs JSON data representing the user node found in the Neo4j database. Specifically, it returns an array of objects where each object contains a user field holding all properties of the matched user node.
Example output structure:
[
{
"user": {
"property1": "value1",
"property2": "value2",
"...": "..."
}
}
]
If no user matches the given External ID, the output will be empty.
The node does not output binary data.
Dependencies
- Requires a Neo4j database instance accessible via host, port, username, password, and optionally a database name.
- Needs credentials configured in n8n containing these connection details.
- Uses the official Neo4j driver library to connect and run Cypher queries.
- Relies on helper functions for running Cypher queries and parsing errors.
Troubleshooting
- Connection Errors: If the node fails to connect, ensure that the Neo4j credentials (host, port, username, password) are correctly set and that the database is reachable.
- Missing Credentials: The node throws an error if any required credential fields are missing or incomplete.
- Query Failures: Errors during query execution are caught and can be handled by enabling "Continue On Fail" to allow partial processing.
- Session Management: Errors closing the Neo4j session or driver are logged but do not stop execution.
- No Results: If no user is found for the given External ID, the output will be empty; verify the External ID value is correct.