IndyKite Developer Hub logo
Back to all resources
ContX IQ ContX IQ Json

ContX IQ: Retrieve All Directly Connected Nodes for a User

Query all nodes that have a direct relationship with a specified User node, regardless of relationship type or direction. Useful for user profile views, data export, or understanding a user's complete data footprint.

ContX IQ: Retrieve All Directly Connected Nodes for a User

This example retrieves all directly connected nodes for a user:

Query pattern:

MATCH (user:User {id: $userId})-[r]-(connected)

RETURN connected

Returns all nodes with ANY direct relationship to the user:

- Incoming relationships: (other)-[r]->(user)

- Outgoing relationships: (user)-[r]->(other)

- Any relationship type

Use cases:

- User profile aggregation

- GDPR data export (all user-related data)

- Impact analysis (what's connected to this user?)

Use case

Scenario: Build a user dashboard showing all related entities.

User graph:

Person(Alice)

-[OWNS]-> Car(Mustang)

-[HAS]-> Email(alice@example.com)

-[WORKS_AT]-> Company(Acme)

-[LIVES_IN]-> Country(USA)

<-[MANAGES]- Manager(Bob)

Query input: userId = "alice"

Query result:

[

{type: "Car", id: "mustang", relationship: "OWNS"},

{type: "Email", id: "alice@example.com", relationship: "HAS"},

{type: "Company", id: "acme", relationship: "WORKS_AT"},

{type: "Country", id: "usa", relationship: "LIVES_IN"},

{type: "Person", id: "bob", relationship: "MANAGES"}

]

All direct connections returned regardless of direction or type.

ikg

Requirements

Prerequisites:

- ServiceAccount credentials: For creating policies and queries (Bearer token)

- AppAgent credentials: For data ingestion and query execution (X-IK-ClientKey)

Application as subject:

- Uses $_appId filter (auto-populated)

- No user token required for this pattern

Steps

Step 1: Ingest Users and Related Nodes

- Authentication: AppAgent credential (X-IK-ClientKey header)

- Action: POST User nodes and various connected nodes with different relationship types

- Result: Rich user graph ready for traversal

Step 2: Create Related Nodes Policy

- Authentication: ServiceAccount credential (Bearer token)

- Action: POST policy allowing READ on nodes connected to users

- Result: Policy ID returned

Step 3: Create Related Nodes Query

- Authentication: ServiceAccount credential (Bearer token)

- Action: POST query that:

- Matches User by input parameter

- Traverses all relationships (any type, any direction)

- Returns connected nodes with relationship info

- Result: Query ID returned

Step 4: Execute Query

- Authentication: AppAgent credential (X-IK-ClientKey header)

- Action: POST to /contx-iq/v1/execute with userId parameter

- Result: Array of all directly connected nodes

5. Delete your configuration.

Step 1

Capture the nodes needed for this use case.

POST https://eu.api.indykite.com/capture/v1/nodes/Json
{
  "nodes": [
    {
      "external_id": "nico",
      "type": "User",
      "is_identity": true,
      "properties": [
        {
          "type": "email",
          "value": "nico@email.com"
        }
      ]
    },
    {
      "external_id": "fred",
      "type": "User",
      "is_identity": true,
      "properties": [
        {
          "type": "email",
          "value": "fred@email.com"
        }
      ]
    },
    {
      "external_id": "customer",
      "type": "Role",
      "properties": [
        {
          "type": "source",
          "value": "Head"
        }
      ]
    },
    {
      "external_id": "norway",
      "type": "Country",
      "properties": [
        {
          "type": "name",
          "value": "Norway"
        }
      ]
    },
    {
      "external_id": "sweden",
      "type": "Country",
      "properties": [
        {
          "type": "name",
          "value": "Sweden"
        }
      ]
    },
    {
      "external_id": "123456",
      "type": "Account",
      "properties": [
        {
          "type": "location",
          "value": "CityHub"
        }
      ]
    },
    {
      "external_id": "234567",
      "type": "Account",
      "properties": [
        {
          "type": "location",
          "value": "Palace"
        }
      ]
    },
    {
      "external_id": "tyrest",
      "type": "Company",
      "properties": [
        {
          "type": "name",
          "value": "Tyrest"
        }
      ]
    },
    {
      "external_id": "blue",
      "type": "Company",
      "properties": [
        {
          "type": "name",
          "value": "Blue"
        }
      ]
    }
  ]
}

Capture the relationships needed for this use case.

POST https://eu.api.indykite.com/capture/v1/relationships/Json
{
  "relationships": [
    {
      "source": {
        "external_id": "nico",
        "type": "User"
      },
      "target": {
        "external_id": "tyrest",
        "type": "Company"
      },
      "type": "PART_OF",
      "properties": [
        {
          "type": "weight",
          "value": 1
        }
      ]
    },
    {
      "source": {
        "external_id": "nico",
        "type": "User"
      },
      "target": {
        "external_id": "norway",
        "type": "Country"
      },
      "type": "WORKS_IN"
    },
    {
      "source": {
        "external_id": "customer",
        "type": "Role"
      },
      "target": {
        "external_id": "nico",
        "type": "User"
      },
      "type": "ASSIGNED_TO"
    },
    {
      "source": {
        "external_id": "123456",
        "type": "Account"
      },
      "target": {
        "external_id": "nico",
        "type": "User"
      },
      "type": "BELONGS_TO"
    },
    {
      "source": {
        "external_id": "fred",
        "type": "User"
      },
      "target": {
        "external_id": "sweden",
        "type": "Country"
      },
      "type": "WORKS_IN"
    },
    {
      "source": {
        "external_id": "customer",
        "type": "Role"
      },
      "target": {
        "external_id": "fred",
        "type": "User"
      },
      "type": "ASSIGNED_TO"
    },
    {
      "source": {
        "external_id": "234567",
        "type": "Account"
      },
      "target": {
        "external_id": "fred",
        "type": "User"
      },
      "type": "BELONGS_TO"
    }
  ]
}

Step 2

Policy which designates the derived query can retrieve all nodes directly related to a User node.

policy.jsonJson
{
  "meta": {
    "policy_version": "1.0-ciq"
  },
  "subject": {
    "type": "_Application"
  },
  "condition": {
    "cypher": "MATCH (subject:_Application) MATCH (u:User)-[]-(n:Resource)",
    "filter": [
      {
        "app": "app1",
        "operator": "AND",
        "operands": [
          {
            "attribute": "subject.external_id",
            "operator": "=",
            "value": "$_appId"
          },
          {
            "attribute": "u.external_id",
            "operator": "=",
            "value": "$user_external_id"
          }
        ]
      }
    ]
  },
  "allowed_reads": {
    "nodes": [
      "u",
      "u.*",
      "n",
      "n.*"
    ]
  }
}

Request to create a CIQ Policy configuration using REST.

POST https://eu.api.indykite.com/configs/v1/authorization-policiesJson
{
  "project_id": "your_project_gid",
  "description": "description of policy",
  "display_name": "policy name",
  "name": "policy-name",
  "policy": "{\"meta\":{\"policy_version\":\"1.0-ciq\"},\"subject\":{\"type\":\"_Application\"},\"condition\":{\"cypher\":\"MATCH (subject:_Application) MATCH (u:User)-[]-(n:Resource)\",\"filter\":[{\"app\":\"app1\",\"operator\":\"AND\",\"operands\":[{\"attribute\":\"subject.external_id\",\"operator\":\"=\",\"value\":\"$_appId\"},{\"attribute\":\"u.external_id\",\"operator\":\"=\",\"value\":\"$user_external_id\"}]}]},\"allowed_reads\":{\"nodes\":[\"u\",\"u.*\",\"n\",\"n.*\"]}}",
  "status": "ACTIVE",
  "tags": []
}

Request to read the CIQ Policy configuration using REST.

policy_request.jsonJson
{
  "id": "your_policy_configuration_gid"
}

Step 3

The CIQ Knowledge Query designates the information you want to retrieve.

knowledge_query.jsonJson
{
  "nodes": [
    "n.external_id",
    "n.type",
    "n.property.*"
  ]
}

Request to create a CIQ Knowledge Query configuration using REST.

POST https://eu.api.indykite.com/configs/v1/knowledge-queriesJson
{
  "project_id": "your_project_gid",
  "description": "description of knowledge query",
  "display_name": "knowledge query name",
  "name": "knowledge-query-name",
  "policy_id": "your_policy_gid",
  "query": "{\"nodes\":[\"n.external_id\",\"n.type\",\"n.property.*\"]}",
  "status": "ACTIVE"
}

Read the CIQ Query Configuration.

GET https://eu.api.indykite.com/configs/v1/knowledge-queries/{id}Json
{
  "id": "your_knowledge_query_configuration_gid"
}

Step 4

CIQ Execution request in json format.

POST https://eu.api.indykite.com/contx-iq/v1/executeJson
{
  "id": "knowledge_query_gid",
  "input_params": {
    "user_external_id": "nico"
  },
  "page_token": 1
}

CIQ Execution response in json format.

response.jsonJson
{
  "data": [
    {
      "nodes": {
        "n.external_id": "123456",
        "n.property.*": [
          {
            "type": "location",
            "value": "CityHub"
          }
        ],
        "n.type": "Account"
      }
    },
    {
      "nodes": {
        "n.external_id": "customer",
        "n.property.*": [
          {
            "type": "source",
            "value": "Head"
          }
        ],
        "n.type": "Role"
      }
    },
    {
      "nodes": {
        "n.external_id": "norway",
        "n.property.*": [
          {
            "type": "name",
            "value": "Norway"
          }
        ],
        "n.type": "Country"
      }
    },
    {
      "nodes": {
        "n.external_id": "tyrest",
        "n.property.*": [
          {
            "type": "name",
            "value": "Tyrest"
          }
        ],
        "n.type": "Company"
      }
    }
  ]
}

Step 5

Delete the CIQ Query.

DELETE https://eu.api.indykite.com/configs/v1/knowledge-queries/{id}Json
{
  "id": "your_knowledge_query_configuration_gid"
}

Delete the CIQ Policy.

DELETE https://eu.api.indykite.com/configs/v1/authorization-policies/{id}Json
{
  "id": "your_policy_configuration_gid"
}

API Endpoints

/capture/v1/nodes
/capture/v1/relationships
/configs/v1/authorization-policies
/configs/v1/knowledge-queries
/contx-iq/v1/execute
View OpenAPI docs

Related Guides

Contx Iq Sandbox

Tags

ContX IQ Policy ContX IQ Query Graph Traversal Related Nodes User Data Direct Relationships

Related Resources

ContX IQ: Query License Numbers a Person Can Access

ContX IQ Python

ContX IQ: Retrieve Payment Methods for Contracted Vehicle Users

ContX IQ Python

ContX IQ: Grant Unrestricted READ Access to a Node Category

ContX IQ Json

ContX IQ: Create Nodes and Relationships via Authorized Write Query

ContX IQ Json

ContX IQ: Upsert Relationships Between Existing Nodes

ContX IQ Json

ContX IQ: Delete Nodes and Their Relationships via Authorized Query

ContX IQ Json

ContX IQ: Loyalty Program - Retrieve Payment Method from License Plate

ContX IQ Json

ContX IQ: Connect System Nodes (_Application) to Business Data

ContX IQ Json

ContX IQ: Complete CRUD Workflow with _Application as Subject

ContX IQ Json

ContX IQ: Role-Based Access Control with User Tokens and Organizations

ContX IQ Json