Collectors-API

ENTWURF — Nur für interne Entwickler

Diese API-Referenz ist für interne Entwicklungsteams bestimmt.

Übersicht

Was es ist: Die Collectors-API verwaltet Konfigurationen von Datenquellen-Collectors. Collectors verbinden sich mit externen Systemen (Active Directory, AWS, Azure, Okta usw.), um Identitätsdaten zu erkennen.

Warum es wichtig ist: Entwickler, die Integrationen erstellen oder Collector-Bereitstellungen verwalten, benötigen programmatischen Zugriff zum Erstellen, Abrufen und Importieren von Collector-Konfigurationen.

Endpunkte

Methode	Pfad	Beschreibung	Authentifizierung erforderlich
GET	/internal/v1/collector/:entity/:eid	Eine bestimmte Collector-Konfiguration abrufen	JWT + API-Token
GET	/internal/v1/collector/:entity	Collector-Konfigurationen nach Entitätstyp auflisten	JWT + API-Token
GET	/internal/v1/datasource/:entity/:eid	Datenquellen-Collectors abrufen	JWT + API-Token
POST	/internal/v1/collection/import/:entity	Eine Collector-Konfiguration importieren	JWT + API-Token
GET	/internal/v1/collection/platforms	Unterstützte Erfassungsplattformen auflisten	JWT + API-Token
GET	/internal/v1/collection/creds	Anmeldeinformationstypen auflisten	JWT + API-Token
GET	/internal/v1/feature/flags	Feature-Flags abrufen	JWT + API-Token

---

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

Eine bestimmte Collector-Konfiguration nach Entitätstyp und Entitäts-ID abrufen.

Pfadparameter:

Parameter	Typ	Beschreibung
entity	string	Entitätstyp (z. B. ActiveDirectory, AWS, Azure, Okta)
eid	string	Entitäts-ID (Collector-Instanzbezeichner)

Anfrage:

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

Antwort (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

Alle Collector-Konfigurationen für einen bestimmten Entitätstyp auflisten.

Anfrage:

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

Antwort (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

Alle unterstützten Erfassungsplattformen auflisten. Verwenden Sie dies, um verfügbare Entitätstypen zu ermitteln.

Anfrage:

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

Antwort (200):

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

---

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

Eine Collector-Konfiguration aus einer Datei oder Vorlage importieren.

Anfrage:

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

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

Antwort (201):

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