Accounts Endpoints

Die Accounts API bietet Endpoints zur Verwaltung von Benutzerkonten, zum Abrufen von Kontodetails und zum Durchführen von Massenoperationen.

Basis-URL

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

---

Konten auflisten

Ruft eine paginierte Liste von Konten mit optionaler Filterung ab.

GET /api/v1/accounts

Query-Parameter

Parameter	Typ	Beschreibung
search	string	Suche nach Kontoname oder E-Mail
department	string	Filtern nach Abteilung
data_source_id	string	Filtern nach Datenquelle
limit	number	Anzahl der zurückzugebenden Elemente (Standard: 50)
after	string	Cursor für Paginierung

Antwort

{
  "accounts": [
    {
      "id": "acc-123",
      "name": "john.doe",
      "email": "john.doe@company.com",
      "display_name": "John Doe",
      "department": "Engineering",
      "status": "active",
      "risk_score": 35,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "cursor-token"
  }
}

---

Konto abrufen

Ruft Details für ein bestimmtes Konto ab.

GET /api/v1/accounts/{id}

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

Gibt das vollständige Kontoobjekt mit allen Feldern zurück.

---

Konto erstellen

Erstellt einen neuen Kontodatensatz.

POST /api/v1/accounts

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

Request Body

{
  "name": "jane.smith",
  "email": "jane.smith@company.com",
  "display_name": "Jane Smith",
  "department": "Finance",
  "data_source_id": "ds-123"
}

Antwort

Gibt das erstellte Kontoobjekt mit generierter id zurück.

---

Konto aktualisieren

Aktualisiert ein bestehendes Konto.

PUT /api/v1/accounts/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Request Body

Nur die zu aktualisierenden Felder einschließen.

Antwort

Gibt das aktualisierte Kontoobjekt zurück.

---

Konto löschen

Löscht einen Kontodatensatz.

DELETE /api/v1/accounts/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

Konten massenhaft abrufen

Ruft mehrere Konten anhand ihrer IDs in einer einzelnen Anfrage ab.

POST /api/v1/accounts/bulk

Request Body

{
  "account_ids": ["acc-123", "acc-456", "acc-789"]
}

Antwort

{
  "accounts": [...],
  "not_found": ["acc-789"]
}

---

Kontoattribute abrufen

Ruft benutzerdefinierte Attribute für ein Konto ab.

GET /api/v1/accounts/{id}/attributes

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

{
  "attributes": {
    "custom_field_1": "value",
    "custom_field_2": "value"
  },
  "count": 2
}

---

Kontogruppenmitgliedschaften abrufen

Ruft Gruppen ab, zu denen ein Konto gehört.

GET /api/v1/accounts/{id}/groupmemberships

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

{
  "groups": [
    {
      "id": "grp-123",
      "name": "Engineering Team",
      "membership_type": "direct"
    }
  ],
  "count": 1
}

---

Kontoeigentümer abrufen

Ruft Eigentümer ab, die einem Konto zugeordnet sind.

GET /api/v1/accounts/{id}/owners

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

{
  "owners": [
    {
      "id": "own-123",
      "name": "John Manager",
      "email": "john.manager@company.com"
    }
  ],
  "count": 1
}

---

Nach Attributen suchen

Sucht Konten nach benutzerdefinierten Attributwerten.

GET /api/v1/accounts/search/attributes

Query-Parameter

Parameter	Typ	Beschreibung
field_name	string	Name des Attributfelds
field_value	string	Zu suchender Wert
limit	number	Anzahl der Ergebnisse

Antwort

Paginierte Liste übereinstimmender Konten.

---

Attributsuch-Statistiken abrufen

Ruft Statistiken über durchsuchbare Attribute ab.

GET /api/v1/accounts/search/attributes/stats

Antwort

{
  "searchable_fields": 15,
  "total_indexed_values": 5000
}

---

Kontoplattformen abrufen

Ruft eindeutige Plattformen mit Kontoanzahlen ab.

GET /api/v1/accounts/platforms

Antwort

{
  "platforms": [
    { "name": "Okta", "count": 1500 },
    { "name": "Azure", "count": 800 }
  ]
}

---

Kontorisiko berechnen

Löst die Berechnung des Risikoscores für ein Konto aus.

POST /api/v1/accounts/{id}/calculate-risk

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Konto-ID

Antwort

{
  "status": "calculating",
  "message": "Risk calculation started"
}

---

Manager-Auflösungs-Endpoints

Manager-Auflösungskonfiguration abrufen

GET /api/v1/accounts/manager-resolution/config

Manager-Auflösungskonfiguration speichern

PUT /api/v1/accounts/manager-resolution/config

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

Request Body

{
  "source_application": "app-123",
  "manager_field_path": "entity.ManagerID",
  "manager_id_field_path": "entity.EmployeeNumber",
  "scheduled_enabled": true
}

Manager-Auflösung ausführen

POST /api/v1/accounts/manager-resolution/run

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

Manager-Auflösungs-Statistiken abrufen

GET /api/v1/accounts/manager-resolution/stats

Antwort

{
  "total_owners": 1000,
  "owners_with_manager": 850,
  "owners_without_manager": 150
}

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Parameter
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
404	Not Found - Konto existiert nicht
500	Internal Server Error

---

Verwandte Themen

• Owners API - Eigentümerverwaltungs-Endpoints
• Groups API - Gruppenverwaltungs-Endpoints
• API Reference - Vollständiger API-Index