Collectors API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The collectors API manages data source collector configurations. Collectors connect to external systems (Active Directory, AWS, Azure, Okta, etc.) to discover identity data.

Why it matters: Developers building integrations or managing collector deployments need programmatic access to create, retrieve, and import collector configurations.

Endpoints

Method	Path	Description	Auth required
GET	/internal/v1/collector/:entity/:eid	Get a specific collector config	JWT + API token
GET	/internal/v1/collector/:entity	List collector configs by entity type	JWT + API token
GET	/internal/v1/datasource/:entity/:eid	Get data source collectors	JWT + API token
POST	/internal/v1/collection/import/:entity	Import a collector configuration	JWT + API token
GET	/internal/v1/collection/platforms	List supported collection platforms	JWT + API token
GET	/internal/v1/collection/creds	List credential types	JWT + API token
GET	/internal/v1/feature/flags	Get feature flags	JWT + API token

---

GET /internal/v1/collector/:entity/:eid

Retrieve a specific collector configuration by entity type and entity ID.

Path parameters:

Parameter	Type	Description
entity	string	Entity type (e.g., ActiveDirectory, AWS, Azure, Okta)
eid	string	Entity ID (collector instance identifier)

Request:

GET /internal/v1/collector/ActiveDirectory/ad-collector-001
Authorization: Bearer <token>

Response (200):

{
  "id": "ad-collector-001",
  "entity": "ActiveDirectory",
  "name": "Corporate AD",
  "status": "active",
  "schedule": "0 2 * * *",
  "credentials": "cred-uuid-001",
  "config": {
    "domain": "corp.example.com",
    "searchBase": "DC=corp,DC=example,DC=com"
  }
}

---

GET /internal/v1/collector/:entity

List all collector configurations for a given entity type.

Request:

GET /internal/v1/collector/AWS
Authorization: Bearer <token>

Response (200):

[
  {
    "id": "aws-001",
    "entity": "AWS",
    "name": "Production AWS",
    "status": "active"
  },
  {
    "id": "aws-002",
    "entity": "AWS",
    "name": "Staging AWS",
    "status": "paused"
  }
]

---

GET /internal/v1/collection/platforms

List all supported collection platforms. Use this to discover which entity types are available.

Request:

GET /internal/v1/collection/platforms
Authorization: Bearer <token>

Response (200):

{
  "platforms": [
    "ActiveDirectory",
    "AWS",
    "Azure",
    "GoogleCloud",
    "Kubernetes",
    "LDAP",
    "Linux",
    "Okta",
    "GitHub",
    "GitLab",
    "SailPoint",
    "ServiceNow",
    "Universal"
  ]
}

---

POST /internal/v1/collection/import/:entity

Import a collector configuration from a file or template.

Request:

POST /internal/v1/collection/import/Universal
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Custom LDAP Collector",
  "config": { ... },
  "credentials": "cred-uuid-001"
}

Response (201):

{
  "id": "imported-collector-uuid",
  "status": "created"
}