Skip to content

AI Assistant Endpoints

Die AI Assistant API bietet Endpoints für die Interaktion mit der KI-gestützten Chat-Oberfläche zum Abfragen von Identitätsdaten und zum Erhalten intelligenter Einblicke.

Basis-URL

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


Chat

Sendet eine Nachricht an den AI-Assistenten und erhält eine Antwort.

http
POST /api/v1/ai/chat

Request Body

json
{
  "message": "Show me all privileged accounts that haven't been used in 90 days",
  "history": [
    {
      "role": "user",
      "content": "Previous message"
    },
    {
      "role": "assistant",
      "content": "Previous response"
    }
  ],
  "stream": true
}

Request-Parameter

ParameterTypBeschreibung
messagestringDie Frage oder Abfrage des Benutzers
historyarrayVorherige Konversationsnachrichten für den Kontext
streambooleanStreaming-Antworten aktivieren (empfohlen: true)

Antwort (Nicht-Streaming)

json
{
  "response": "I found 15 privileged accounts that haven't been used...",
  "tools_used": ["query_accounts"],
  "status": "complete"
}

Antwort (Streaming)

Wenn stream: true, wird die Antwort als Server-Sent Events (SSE) geliefert:

event: content
data: {"text": "I found "}

event: content
data: {"text": "15 privileged accounts..."}

event: tool_results
data: {"tools": ["query_accounts"], "count": 15}

event: status
data: {"status": "complete"}

event: [DONE]
data: {}

SSE-Ereignistypen

EreignisBeschreibung
contentTextinhalt wird gestreamt
tool_resultsVerwendete Tools und ihre Ergebnisse
statusFortschrittsaktualisierungen
warningWarnungen (z. B. Datenlimits erreicht)
[DONE]Abschlusssignal

Abfragefähigkeiten

Der AI-Assistent kann die folgenden Datentypen abfragen, wenn die entsprechenden Funktionen aktiviert sind:

Identitätsdaten (identity_data Feature)

ToolBeschreibung
query_accountsKonten suchen und filtern
query_groupsGruppen suchen und filtern
query_ownersEigentümer suchen und filtern
query_applicationsAnwendungen suchen und filtern

Konfiguration (configuration Feature)

ToolBeschreibung
query_campaign_rulesCampaign-Regeln suchen
query_policiesRichtlinien suchen
query_rolesRollen suchen

Campaigns (campaigns Feature)

ToolBeschreibung
list_campaignsAktive Campaigns auflisten
query_approvalsGenehmigungsstatus abfragen
query_complianceCompliance-Metriken abfragen

Beispielabfragen

Sicherheitsfragen

json
{
  "message": "Find accounts with high threat levels and no MFA",
  "stream": true
}

Zugriffskontrolle

json
{
  "message": "Which users have access to critical applications?",
  "stream": true
}

Compliance

json
{
  "message": "Show me accounts with policy violations",
  "stream": true
}

Analytik

json
{
  "message": "What department has the most inactive accounts?",
  "stream": true
}

Konversationskontext

Der AI-Assistent behält den Konversationskontext über den history-Parameter bei:

json
{
  "message": "Which of these are in the Finance department?",
  "history": [
    {
      "role": "user",
      "content": "Show me privileged accounts"
    },
    {
      "role": "assistant",
      "content": "I found 50 privileged accounts..."
    }
  ],
  "stream": true
}

Zugriffskontrolle

AI-Funktionen werden gesteuert durch:

  1. Master Toggle - Globales AI-Aktivieren/Deaktivieren
  2. Feature-Berechtigungen - Granulare Kontrolle pro Feature-Gruppe
  3. Benutzerrolle - Begrenzter Zugriff für Reviewer und Auditors

Administratoren haben vollen Zugriff, wenn AI aktiviert ist. Reviewer und Auditors greifen auf AI-Funktionen innerhalb ihres konfigurierten Bereichs zu.


Fehlerantworten

StatuscodeBeschreibung
400Bad Request - Ungültiges Nachrichtenformat
401Unauthorized - Authentifizierung erforderlich
403Forbidden - AI-Funktionen deaktiviert oder unzureichende Berechtigungen
429Too Many Requests - Ratenlimit überschritten
500Internal Server Error

Fehlerantwortformat

json
{
  "error": {
    "code": "AI_DISABLED",
    "message": "AI features are not enabled for this tenant"
  }
}

Ratenbegrenzung

AI-Anfragen sind ratenbegrenzt, um Missbrauch zu verhindern. Wenn Sie eine 429-Antwort erhalten, warten Sie vor dem erneuten Versuch.


Verwandte Themen

Hydden Documentation and Training Hub