Sync Endpoints

Die Sync API bietet Endpoints zum Auslösen und Überwachen der Datensynchronisierung von der Hydden-Plattform zu Hydden.Control.

Basis-URL

Alle Endpoints sind relativ zu /api/v1/sync.

---

Vollständige Synchronisierung auslösen

Löst eine vollständige Synchronisierung aller Entitätstypen aus.

POST /api/v1/sync/all

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Antwort

{
  "status": "queued",
  "job_id": "job-123",
  "message": "Full sync initiated"
}

---

Spezifische Synchronisierung auslösen

Löst Synchronisierung für bestimmte Entitätstypen aus.

Konten synchronisieren

POST /api/v1/sync/accounts

Kontoattribute synchronisieren

POST /api/v1/sync/account-attributes

Gruppen synchronisieren

POST /api/v1/sync/groups

Anwendungen synchronisieren

POST /api/v1/sync/applications

Eigentümer synchronisieren

POST /api/v1/sync/owners

Eigentümer-Konto-Beziehungen synchronisieren

POST /api/v1/sync/owner-accounts

Gruppenmitgliedschaften synchronisieren

POST /api/v1/sync/group-memberships

Plattformbenutzer synchronisieren

POST /api/v1/sync/platform-users

Alle Sync-Endpoints geben zurück:

{
  "status": "queued",
  "job_id": "job-123",
  "message": "[Entity] sync initiated"
}

---

Synchronisierungsstatus abrufen

Ruft aktuellen Synchronisierungsstatus ab.

GET /api/v1/sync/status

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Antwort

{
  "last_sync": "2024-02-01T10:00:00Z",
  "status": "idle",
  "running_jobs": 0
}

---

Sync-Job-Status abrufen

Ruft Status für einen bestimmten Sync-Job ab.

GET /api/v1/sync/status/{jobId}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
jobId	string	Job-ID

Antwort

{
  "id": "job-123",
  "job_type": "full_sync",
  "status": "running",
  "progress": 65,
  "start_time": "2024-02-01T10:00:00Z"
}

---

Synchronisierungshistorie abrufen

Ruft Synchronisierungshistorie ab.

GET /api/v1/sync/history

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Query-Parameter

Parameter	Typ	Beschreibung
status	string	Nach Status filtern
data_source	string	Nach Datenquelle filtern
limit	number	Anzahl der zurückzugebenden Elemente

Antwort

{
  "history": [
    {
      "id": "job-123",
      "job_type": "full_sync",
      "status": "completed",
      "start_time": "2024-02-01T10:00:00Z",
      "end_time": "2024-02-01T10:15:00Z",
      "records": {
        "created": 150,
        "updated": 45,
        "deleted": 10
      }
    }
  ]
}

---

Synchronisierungsstatistiken abrufen

Ruft Synchronisierungsstatistiken ab.

GET /api/v1/sync/statistics

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Antwort

{
  "total_accounts": 5000,
  "total_owners": 1200,
  "total_groups": 350,
  "total_applications": 45,
  "last_full_sync": "2024-02-01T10:00:00Z",
  "data_sources": [
    { "name": "Entra", "accounts": 3000 },
    { "name": "Okta", "accounts": 2000 }
  ]
}

---

Task-Status abrufen

Ruft Status für eine Hintergrundaufgabe ab.

GET /api/v1/sync/tasks/{taskId}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
taskId	string	Task-ID

Antwort

{
  "id": "task-123",
  "status": "completed",
  "progress": 100,
  "result": {...}
}

---

Manager auflösen

Löst Manager-Hierarchie-Auflösung aus.

POST /api/v1/sync/resolve-managers

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Antwort

{
  "status": "queued",
  "message": "Manager resolution initiated"
}

---

Alle Tenant-Daten löschen

Löscht alle synchronisierten Daten für den Tenant.

DELETE /api/v1/sync/delete-all

Destruktive Aktion

Diese Aktion löscht permanent alle Konten, Eigentümer, Gruppen, Anwendungen und zugehörige Daten. Dies kann nicht rückgängig gemacht werden.

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Parameter
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
409	Conflict - Synchronisierung läuft bereits
500	Internal Server Error

---

Verwandte Themen

• Jobs API - Job-Überwachungs-Endpoints
• Data Sync - Benutzerhandbuch
• API Reference - Vollständiger API-Index