IndyKite

https://docs.indykite.com
Admin
IndyKite is an identity-centric data and access control platform that uses an Identity Knowledge...
Tokens:69,968
Snippets:628
Trust Score:7.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### URL placeholder syntax examples

Source: https://docs.indykite.com/docs/examples/data-resolver-placeholders

Examples of valid URL placeholder configurations for paths and query parameters.

```text
{$myValue}
```

```text
{$myValue || 123}
```

```text
?a={$var || Hello world!}
```

--------------------------------

### Install the Go SDK

Source: https://docs.indykite.com/docs/apis/sdks/go-sdk

Installs the Indykite Go SDK. Requires Go version 1.22 or later.

```bash
go install github.com/indykite/indykite-sdk-go  
```

--------------------------------

### Install Python SDK

Source: https://docs.indykite.com/docs/apis/sdks/python-sdk

Use pip to install the Indykite Python SDK package.

```bash
pip install indykite-sdk-python
```

--------------------------------

### Body placeholder syntax examples

Source: https://docs.indykite.com/docs/examples/data-resolver-placeholders

Examples of valid JSON body placeholder configurations, including numeric and string defaults.

```json
"$myValue"
```

```json
{"key": "$myVvalue || 1.23e-10"}
```

```json
{"key": "$myValue || \"default\""}
```

```json
{"$myValue || {\"default\": \"object\"}"}
```

--------------------------------

### ContX IQ policy and query example

Source: https://docs.indykite.com/docs/agent-gateway/workflow-setup

Example ContX IQ policy and query that returns which workflows the protected agent belongs to and which agent chain is allowed in each workflow.

```json
{
  "meta": {
    "policy_version": "1.0-ciq"
  },
  "subject": {
    "type": "_Application"
  },
  "condition": {
    "cypher": "MATCH (subject:_Application) MATCH (wf:Workflow)-[rels:INVOKES*]->(a:Agent {external_id: $agent_id}) WHERE ALL(r IN rels WHERE r.workflow_name = wf.external_id AND endNode(r):Agent) WITH subject, wf.external_id AS workflow, [r IN rels | endNode(r).external_id] AS agent_list",
    "filter": []
  },
  "allowed_reads": {
    "nodes": [],
    "relationships": [],
    "aggregate_values": [
      "workflow",
      "agent_list"
    ]
  }
}
```

```json
{
  "aggregate_values": [
    "workflow",
    "agent_list"
  ]
}
```

--------------------------------

### Full data resolver response example

Source: https://docs.indykite.com/docs/examples/data-resolver-jq

Example full response from a data resolver, showing nested objects, arrays, arrays of arrays, and special key cases (numeric key, quoted key with brackets, dotted key).

```json
{  

"text": "abc",  

"obj": {  

    "secondLevel": [  

    {  

        "someValue": 123  

    },  

    {  

        "someValue": 456.789  

    },  

    {  

        "someValue": [  

        "value1",  

        "value1.1"  

        ]  

    },  

    {  

        "someValue": null  

    },  

    {  

        "someValue": false  

    }  

    ],  

    "arrayOfArrays": [  

    [1, 2, 3],  

    [4, 5, 6],  

    [7, 8, 9]  

    ],  

    "specialCases": {  

    "123": "pure numeric key",  

    "super-'key'[1]": "value",  

    "dotted.key.within": ["a", "b", "c"]  

    }  

}  

}  
```

--------------------------------

### Define Property Metadata

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Example showing how to include metadata such as source system or assurance level within a property definition.

```json
"properties": [  

  {  

    "type": "status",  

    "value": "active",  

    "metadata": [  

      { "type": "source", "value": "CRM" },  

      { "type": "assuranceLevel", "value": 2 }  

    ]  

  }  

]
```

--------------------------------

### Example JSON policy file

Source: https://docs.indykite.com/docs/examples/json-authz-policy

A complete example of a JSON authorization policy file. It defines a policy version, a subject of type Person, an action CAN_DRIVE, a resource of type Car, and a cypher condition that requires a path from the subject to the resource via an OWNS relationship.

```json
{
  "meta": {
    "policyVersion": "1.0-indykite"
  },
  "subject": {
    "type": "Person"
  },
  "actions": [
    "CAN_DRIVE"
  ],
  "resource": {
    "type": "Car"
  },
  "condition": {
    "cypher": "MATCH (subject:Person)-[:OWNS]->(resource:Car)"
  }
}
```

--------------------------------

### WhoAuthorized response example

Source: https://docs.indykite.com/docs/apis/authorizationapi

Example response from the WhoAuthorized API. Shows decisionTime and a decisions object with per-resource and per-action subject lists.

```json
{  

  "decisionTime": "2022-12-12T08:39:00.110145Z",  

  "decisions": {  

		"Car": {  

			"resources": {  

                "carA": {  

                    "actions": {  

                        "CAN_DRIVE": {  

                            "subjects": [  

                                {"externalID": "subjectA"},  

                            ]  

                        },  

                        "CAN_PERFORM_SERIVCE": {  

                            "subjects": [  

                                {"externalID": "subjectB"},  

                            ]  

                        },  

                    },  

                },  

                "carB": {  

                        "Actions": {  

                            "CAN_DRIVE": {  

                            "subjects": [  

                                {"externalID": "subjectC"},  

                            ]  

                        },  

                    },  

                },  

            },  

	    },  

	},  

}  



```

--------------------------------

### IsAuthorized Response Example

Source: https://docs.indykite.com/docs/apis/authorizationapi

Example JSON response body for the IsAuthorized endpoint, detailing the decision time and the allow status for specific actions on resources.

```json
{

  "decisionTime": "2022-12-12T08:39:00.110145Z",  

  "decisions": {  

		"Car": {  

			"Resources": {  

		    "carA": {  

					"Actions": {  

				    "CAN_DRIVE": {  

							"allow": true,  

						},  

				    "CAN_PERFORM_SERIVCE": {  

							"allow": false,  

						},  

					},  

		    },  

		    "carB": {  

					"Actions": {  

						"CAN_DRIVE": {  

							"allow": false,  

						},  

					},  

				},  

			},  

	  },  

	},  

}  
```

--------------------------------

### Example request body for search/resource

Source: https://docs.indykite.com/docs/apis/authzen-api

A JSON request body containing the subject, resource, action, and optional context parameters.

```json
{

  "subject": {  

    "type": "User",  

    "id": "alice@acmecorp.com"  

  },  

  "resource": {  

    "type": "Account"  

  },  

  "action": {  

    "name": "CAN_READ"  

  },  

  "context": {  

    "policy_tags": [  

      "tag1"  

    ],  

    "input_params": {  

      "department": "Sales"  

    }  

  }  

}
```

--------------------------------

### Example response body for search/resource

Source: https://docs.indykite.com/docs/apis/authzen-api

A JSON response body containing an array of resources that the subject is authorized to access.

```json
{

  "results": [  

    {  

      "type": "Account",  

      "id": "123"  

    },  

    {  

      "type": "Account",  

      "id": "456"  

    }  

  ]  

}
```

--------------------------------

### Check Terraform version

Source: https://docs.indykite.com/docs/terraform-provider/terraform-provider-setup

Verify the installed version of Terraform.

```bash
terraform -v
```

--------------------------------

### nodes array wildcard example

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Shows how to use the wildcard to return all properties permitted by the policy for a variable.

```json
"nodes": ["person.property.*"]  
```

--------------------------------

### KBAC/AuthZEN policy example

Source: https://docs.indykite.com/docs/agent-gateway/workflow-setup

Example policy that answers whether a subject may trigger a workflow. Assumes a relationship like (:Person)-[:CAN_TRIGGER]->(:Workflow). If using additional subject types, create matching policies and list them in authzen.subject_types.

```json
{
  "meta": {
    "policyVersion": "1.0-kbac"
  },
  "subject": {
    "type": "Person"
  },
  "actions": [
    "CAN_TRIGGER"
  ],
  "resource": {
    "type": "Workflow"
  },
  "condition": {
    "cypher": "MATCH (subject)-[:CAN_TRIGGER]->(resource:Workflow)"
  }
}
```

--------------------------------

### aggregate_values query example

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Shows how to specify the aggregate_values array to return the aggregated result.

```json
"aggregate_values": ["roles"]  
```

--------------------------------

### nodes array example

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Shows how to specify the nodes array with property paths for vehicle, person, and pm variables.

```json
"nodes": [  

  "vehicle.property.isActive",  

  "person.property.givenName",  

  "person.property.lastName",  

  "pm.property.reservation"  

]  
```

--------------------------------

### Define indykite_external_data_resolver GET resource

Source: https://docs.indykite.com/docs/onboard/data-references

Example configuration for an external data resolver using the GET method.

```hcl
resource "indykite_external_data_resolver" "get-resolver" {  

  name         = "terraform-resolver-get"  

  display_name = "Terraform external data resolver get"  

  description  = "External data resolver for terraform pipeline"  

  location     = "AppSpaceID"  

  

  url    = "https://www.example.com/sourceresolver?data=xxx"  

  method = "GET"  

  headers {  

    name   = "Authorization"  

    values = ["Bearer edolkUTY"]  

  }  

  request_type      = "json"  

  response_type     = "json"  

  response_selector = ".resp"  

}  
```

--------------------------------

### Import the Go SDK

Source: https://docs.indykite.com/docs/apis/sdks/go-sdk

Imports the Indykite Go SDK into your application.

```go
import "github.com/indykite/indykite-sdk-go"  
```

--------------------------------

### IsAuthorized Request Example

Source: https://docs.indykite.com/docs/apis/authorizationapi

Example JSON request body for the IsAuthorized endpoint, specifying the subject, a list of resources with actions, input parameters, and policy tags.

```json
{

    "subject": {  

        "external_id": {  

            "type": "Person",  

            "external_id": "person1"  

        }  

    },  

    "resources": [  

        {  

            "externalId": "carA",  

            "type": "Car",  

            "actions": [  

                "CAN_DRIVE"  

            ]  

        },  

        {  

            "externalId": "carB",  

            "type": "Car",  

            "actions": [  

                "CAN_DRIVE"  

            ]  

        }  

    ],  

    "input_params": {  

        "color": {  

            "string_value": "red"  

        }  

    },  

    "policy_tags": ["CarPolices"]  

}  
```

--------------------------------

### Set Windows Environment Variables

Source: https://docs.indykite.com/docs/apis/sdks/python-sdk

Configure service account and application credentials for Windows environments.

```bash
setex INDYKITE_SERVICE_ACCOUNT_CREDENTIALS_FILE="C:\Users\xx\Documents\configuration.json"
```

```bash
setex INDYKITE_APPLICATION_CREDENTIALS_FILE="C:\Users\xx\Documents\configuration.json"
```

```bash
setex INDYKITE_APPLICATION_CREDENTIALS=<JSON value>
```

--------------------------------

### WhoAuthorized request example

Source: https://docs.indykite.com/docs/apis/authorizationapi

Example request body for the WhoAuthorized API. It lists resources with externalId and type, optionally actions, plus input_params and policy_tags to filter policies.

```json
{  

    "resources": [  

        {  

            "externalId": "carA",  

            "type": "Car"  

        },  

        {  

            "externalId": "carB",  

            "type": "Car",  

            "actions": [  

                "CAN_DRIVE"  

            ]  

        }  

    ],  

    "input_params": {  

        "color": {  

            "string_value": "red"  

        }  

    },  

    "policy_tags": ["CarPolices"]  

}  



```

--------------------------------

### Example 3: Policy with path traversal and property comparisons

Source: https://docs.indykite.com/docs/examples/json-authz-policy

Defines a policy for renting a car, requiring a path through a rental company and property nodes with specific conditions. The condition uses multiple MATCH clauses and comparisons.

```json
{
  "meta": {
    "policyVersion": "1.0-indykite"
  },
  "subject": {
    "type": "Person"
  },
  "actions": [
    "CAN_RENT"
  ],
  "resource": {
    "type": "Car"
  },
  "condition": {
    "cypher": "MATCH (pp:Property {type:'loa'})<-[:HAS]-(subject:Person)-[*0..5]->()-[:SUBSCRIBED_TO]->(:RentalCompany)-[:OPERATES_AT*1..2]->(:Location)-[:CONTROLS]->(resource:Car)-[:HAS]->(cp:Property {type:'minAge'}) MATCH (subject)-[:HAS]->(sp:Property {type:'age'}) WHERE sp.value >= cp.value AND pp.value > 1"
  }
}
```

--------------------------------

### Example 2: Policy with WITH clause and WhoAuthorized request

Source: https://docs.indykite.com/docs/examples/json-authz-policy

Similar to Example 1 but includes a WITH clause in the condition. The resulting Cypher for WhoAuthorized request is shown, returning subject external IDs.

```json
{
  "meta": {
    "policyVersion": "1.0-indykite"
  },
  "subject": {
    "type": "Person"
  },
  "actions": [
    "CAN_DRIVE"
  ],
  "resource": {
    "type": "Car"
  },
  "condition": {
    "cypher": "MATCH (resource)-[:HAS]->(p:Property) WHERE p.type='color' AND p.value=$color WITH subject, resource, p MATCH (subject)-[:OWNS]->(resource)",
    "inputParams": ["color"]
  }
}
```

```cypher
MATCH (subject:DigitalTwin:Person)
MATCH (resource:Resource:Car) WHERE resource.external_id IN $resource_ids
MATCH (resource)-[:HAS]->(p:Property) WHERE p.type='color' AND p.value=$color WITH subject, resource, p MATCH (subject)-[:OWNS]->(resource)
RETURN {allowed: collect(DISTINCT subject.external_id)};
```

--------------------------------

### Query filter example for license plate

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Example of a query-level filter that narrows results to a specific license plate at query time. The filter has the same structure as the policy filter but without the app field; omit it if no additional filtering is needed.

```json
"filter": {
  "attribute": "ln.property.value",
  "operator": "=",
  "value": "$lnValue"
}
```

--------------------------------

### Set Linux Environment Variables

Source: https://docs.indykite.com/docs/apis/sdks/python-sdk

Configure service account and application credentials for Linux environments.

```bash
export INDYKITE_SERVICE_ACCOUNT_CREDENTIALS_FILE=/home/user/configuration.json
```

```bash
export INDYKITE_APPLICATION_CREDENTIALS_FILE=/home/user/configuration.json
```

```bash
export INDYKITE_APPLICATION_CREDENTIALS=<JSON value>
```

--------------------------------

### Example response body for search/action

Source: https://docs.indykite.com/docs/apis/authzen-api

This JSON object shows the successful response from the search/action endpoint, returning an array of actions the subject is permitted to perform on the resource.

```json
{

  "results": [

    {

      "name": "CAN_READ"

    },

    {

      "name": "CAN_WRITE"

    }

  ]

}
```

--------------------------------

### Assumed relationship for KBAC policy

Source: https://docs.indykite.com/docs/agent-gateway/workflow-setup

The relationship that the KBAC policy example assumes.

```cypher
(:Person)-[:CAN_TRIGGER]->(:Workflow)
```

--------------------------------

### Delete Relationships

Source: https://docs.indykite.com/docs/examples/ingest-examples

Example request to delete a relationship by specifying the source, target, and relationship type.

```json
{
  "relationships": [
    {
      "type": "RENT",
      "source": {
        "external_id": "customerA",
        "type": "Customer"
      },
      "target": {
        "external_id": "car1",
        "type": "Car"
      }
    }
  ]
}
```

--------------------------------

### Policy cypher with COLLECT

Source: https://docs.indykite.com/docs/control/contx-iq/query-syntax

Example policy cypher that uses COLLECT to aggregate role names.

```cypher
MATCH (subject:Person)-[:HAS_ROLE]->(role:Role)  

WITH subject, COLLECT(role.name) AS roles  
```

--------------------------------

### Set service account credentials (Windows)

Source: https://docs.indykite.com/docs/apis/sdks/go-sdk

Sets the service account credentials file path for Windows.

```bash
setex INDYKITE_SERVICE_ACCOUNT_CREDENTIALS_FILE="C:\Users\xx\Documents\configuration.json"  
```
Tokens:
Raw