Skip to content

Applications Endpoints

Die Applications API bietet Endpoints zum Entdecken, Verwalten und Überwachen von Anwendungen und ihren zugehörigen Konten.

Basis-URL

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


Anwendungen auflisten

Ruft eine paginierte Liste von Anwendungen mit optionaler Filterung ab.

http
GET /api/v1/applications

Query-Parameter

ParameterTypBeschreibung
searchstringNach Anwendungsname filtern (Teilübereinstimmung)
criticalitystringNach Kritikalitätsstufe filtern
ownerstringNach Eigentümer-E-Mail filtern
min_risknumberMinimaler Risikoscore (0-100)
max_risknumberMaximaler Risikoscore (0-100)
firstnumberAnzahl der zurückzugebenden Elemente (Standard: 50)
afterstringCursor für Paginierung

Antwort

json
{
  "applications": [
    {
      "id": "app-123",
      "application_id": "source-app-id",
      "name": "Salesforce",
      "description": "CRM platform",
      "criticality": "high",
      "owner": "admin@company.com",
      "status": "active",
      "risk_score": 45,
      "total_accounts": 250,
      "average_risk_score": 42,
      "data_source_platform": "Okta",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-01T14:22:00Z"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "cursor-token"
  }
}

Anwendung abrufen

Ruft Details für eine bestimmte Anwendung ab.

http
GET /api/v1/applications/{id}

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Antwort

json
{
  "id": "app-123",
  "application_id": "source-app-id",
  "name": "Salesforce",
  "description": "CRM platform",
  "criticality": "high",
  "owner": "admin@company.com",
  "technical_contact": "tech@company.com",
  "business_contact": "business@company.com",
  "compliance_required": true,
  "risk_score": 45,
  "data_classification": "confidential",
  "environment": "production",
  "status": "active",
  "url": "https://company.salesforce.com",
  "auth_method": "SAML",
  "last_review_date": "2024-01-01T00:00:00Z",
  "next_review_date": "2024-07-01T00:00:00Z",
  "data_source_id": "ds-456",
  "data_source_name": "Corporate Okta",
  "data_source_platform": "Okta",
  "total_accounts": 250,
  "average_risk_score": 42,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-01T14:22:00Z"
}

Anwendungskonten abrufen

Ruft Konten ab, die einer bestimmten Anwendung zugeordnet sind.

http
GET /api/v1/applications/{id}/accounts

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Query-Parameter

ParameterTypBeschreibung
limitnumberAnzahl der zurückzugebenden Konten (Standard: 10)
offsetnumberOffset für Paginierung

Antwort

json
{
  "accounts": [
    {
      "id": "acc-789",
      "name": "john.doe",
      "email": "john.doe@company.com",
      "display_name": "John Doe",
      "account_type": "user",
      "department": "Engineering",
      "status": "active",
      "risk_level": "medium"
    }
  ],
  "total": 250,
  "limit": 10,
  "offset": 0
}

Kontoanzahlen für mehrere Anwendungen abrufen

Ruft Kontoanzahlen für mehrere Anwendungen in einer einzelnen Anfrage ab.

http
POST /api/v1/applications/accounts

Request Body

json
{
  "application_ids": ["app-123", "app-456", "app-789"]
}

Antwort

json
{
  "app-123": 250,
  "app-456": 45,
  "app-789": 120
}

Anwendungsstatistiken abrufen

Ruft detaillierte Statistiken und Metriken für eine Anwendung ab.

http
GET /api/v1/applications/{id}/statistics

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Antwort

json
{
  "total_accounts": 250,
  "average_risk_score": 42,
  "mfa_disabled": {
    "count": 15,
    "percentage": 6
  },
  "password_issues": {
    "never_set": 2,
    "over_90_days": 45,
    "over_180_days": 20,
    "over_365_days": 8
  },
  "stale_accounts": {
    "over_90_days": 30,
    "over_180_days": 15,
    "over_365_days": 5
  },
  "privileged_accounts": {
    "total": 25,
    "highly_privileged": 8,
    "not_vaulted": 3,
    "not_vaulted_percentage": 12
  },
  "other_risks": {
    "shared_accounts": 5,
    "no_owner": 12,
    "breached": 0,
    "failed_logins": 3
  },
  "account_distribution": {
    "by_status": {
      "active": 220,
      "disabled": 25,
      "suspended": 5
    },
    "by_type": {
      "user": 200,
      "service": 35,
      "admin": 15
    }
  }
}

Anwendung erstellen

Erstellt einen neuen Anwendungsdatensatz.

http
POST /api/v1/applications

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

Request Body

json
{
  "name": "New Application",
  "description": "Application description",
  "criticality": "medium",
  "owner": "owner@company.com",
  "technical_contact": "tech@company.com",
  "business_contact": "business@company.com",
  "compliance_required": false,
  "data_classification": "internal",
  "environment": "production",
  "status": "active",
  "url": "https://app.company.com",
  "auth_method": "OAuth2"
}

Antwort

Gibt das erstellte Anwendungsobjekt mit generierter id und Zeitstempeln zurück.


Anwendung aktualisieren

Aktualisiert eine bestehende Anwendung.

http
PUT /api/v1/applications/{id}

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

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Request Body

Nur die zu aktualisierenden Felder einschließen:

json
{
  "description": "Updated description",
  "criticality": "high",
  "status": "active"
}

Antwort

Gibt das aktualisierte Anwendungsobjekt zurück.


Anwendungseigentümer aktualisieren

Aktualisiert den Eigentümer einer Anwendung.

http
PUT /api/v1/applications/{id}/owner

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

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Request Body

json
{
  "owner": "newowner@company.com"
}

Antwort

Gibt das aktualisierte Anwendungsobjekt zurück.


Anwendung löschen

Löscht einen Anwendungsdatensatz.

http
DELETE /api/v1/applications/{id}

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

Path-Parameter

ParameterTypBeschreibung
idstringAnwendungs-ID

Antwort

json
{
  "success": true,
  "message": "Application deleted successfully"
}

Fehlerantworten

Alle Endpoints können die folgenden Fehlerantworten zurückgeben:

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

Fehlerantwortformat

json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid application ID format"
  }
}

Verwandte Themen

Hydden Documentation and Training Hub