# IndyKite Developer Hub

> A collection of developer resources, code samples, and guides to implement IndyKite products: ContX IQ, AuthZEN authorization, TrustScore, and Outbound Events.

## Site Structure

- /: Home page with featured resources and categories
- /resources: Code samples and API usage examples
- /guides: Step-by-step implementation guides
- /terraform: Terraform configuration examples
- /tools: Developer utilities and scripts
- /api: API reference overview

## Machine-Readable Endpoints (for agents)

### Quick Start

To discover all available code examples, fetch:

```
GET https://developer.indykite.com/api/resources.json
```

This returns a JSON array of 33 resources with metadata. Use this to:
- Search by category (ContX IQ, KBAC, Environment, Events)
- Filter by tags or API type
- Find relevant openApiEndpoints and relatedGuides
- Get links to full content (markdown or JSON)

### Available Endpoints

| Endpoint | Description |
|----------|-------------|
| /api/resources.json | Index of all code examples with metadata |
| /api/terraform.json | Index of all Terraform configurations with metadata |
| /resources/{id}.json | Full resource data as JSON (includes code) |
| /resources/{id}.md | Resource content as markdown |
| /terraform/{id}.json | Full Terraform config as JSON (includes HCL code) |
| /terraform/{id}.md | Terraform example as markdown |
| /guides/{id}.md | Guide content as markdown |
| /tools/{id}.md | Tool documentation as markdown |

### Available Guides

| Guide | Description |
|-------|-------------|
| /guides/guide-products.md | **Start here** - All products, architecture, and relationships |
| /guides/guide-sandbox.md | Getting started with the Sandbox environment |
| /guides/guide-environment.md | Projects, applications, and credentials hierarchy |
| /guides/guide-credentials.md | Service Account vs Application Agent credentials |
| /guides/guide-contx-iq.md | ContX IQ queries with authorization |
| /guides/guide-kbac.md | Knowledge-Based Access Control policies |
| /guides/guide-dynamic-authz.md | Dynamic authorization with Knowledge Graphs |
| /guides/guide-authzen.md | AuthZEN standard compliance |
| /guides/guide-external-data-resolver.md | Fetch external API data at query time |
| /guides/guide-trust-score.md | Data quality assessment and scoring |
| /guides/guide-outbound-events.md | Event streaming to Kafka, Azure |
| /guides/guide-terraform.md | Infrastructure as code with Terraform |
| /guides/guide-mcp.md | Model Context Protocol for AI agents |

### Resource Schema

Each resource in /api/resources.json contains:

```json
{
  "id": "ciq-basic",
  "title": "ContX IQ: Query License Numbers...",
  "description": "Query the IndyKite Knowledge Graph...",
  "category": "ContX IQ",
  "tags": ["ContX IQ Policy", "Graph Traversal"],
  "api": "ContX IQ",
  "lastUpdated": "2026-03-20",
  "openApiEndpoints": ["/contx-iq/v1/execute", "/configs/v1/knowledge-queries"],
  "relatedGuides": ["/guides/guide-contx-iq", "/guides/guide-sandbox"],
  "commonErrors": [
    {
      "code": "401",
      "message": "UNAUTHENTICATED",
      "solution": "Check credentials: ServiceAccount Bearer token for config APIs, X-IK-ClientKey for execution"
    }
  ],
  "links": {
    "html": "/resources/ciq-basic",
    "markdown": "/resources/ciq-basic.md",
    "json": "/resources/ciq-basic.json"
  }
}
```

### Terraform Schema

Each terraform config in /api/terraform.json contains:

```json
{
  "id": "terraform-3",
  "title": "Kafka Outbound Events / Signal - Config",
  "description": "Create an Outbound Events configuration with a Kafka provider.",
  "category": "Outbound Events",
  "lastUpdated": "2026-03-20",
  "terraformProviderDocs": [
    "https://registry.terraform.io/providers/indykite/indykite/latest/docs/resources/event_sink"
  ],
  "relatedGuides": ["/guides/guide-terraform", "/guides/guide-outbound-events"],
  "commonErrors": [
    {
      "code": "ALREADY_EXISTS",
      "message": "Only one event sink per project",
      "solution": "Delete the existing event sink before creating a new one"
    }
  ],
  "links": {
    "html": "/terraform/terraform-3",
    "markdown": "/terraform/terraform-3.md",
    "json": "/terraform/terraform-3.json"
  }
}
```

### Example Workflow

**For REST API examples:**
1. Fetch /api/resources.json to discover resources
2. Filter by category, tags, or api field to find relevant examples
3. Fetch full content via links.markdown or links.json
4. Check openApiEndpoints for API documentation at https://openapi.indykite.com
5. Check relatedGuides for step-by-step instructions
6. Use commonErrors for troubleshooting

**For Terraform configurations:**
1. Fetch /api/terraform.json to discover Terraform examples
2. Filter by category (Token Introspect, Environment, Outbound Events)
3. Fetch full content via links.markdown or links.json
4. Check terraformProviderDocs for Terraform registry documentation
5. Use commonErrors for troubleshooting Terraform apply failures

## Product Overview

For a comprehensive guide to all IndyKite products and how they relate:
- /guides/guide-products.md - Products overview with architecture diagram

## Main Topics

- Identity Knowledge Graph (IKG): Store nodes and relationships
- ContX IQ (CIQ): Context-aware data queries with authorization
- KBAC: Knowledge-Based Access Control for allow/deny decisions
- Token Introspect: Validate tokens and map to IKG nodes
- External Data Resolver: Fetch external API data at query time
- Trust Score: Assess data quality and use in authorization
- Outbound Events: Push notifications on data changes
- Terraform: Infrastructure as code for IndyKite

## External Resources

- Documentation: https://docs.indykite.com/
- OpenAPI Definitions: https://openapi.indykite.com/
- GitHub: https://github.com/indykite/developer-hub

## Contact

- Website: https://indykite.com
- Twitter: @indykite