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.
POST /api/v1/ai/chatRequest Body
{
"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
| Parameter | Typ | Beschreibung |
|---|---|---|
message | string | Die Frage oder Abfrage des Benutzers |
history | array | Vorherige Konversationsnachrichten für den Kontext |
stream | boolean | Streaming-Antworten aktivieren (empfohlen: true) |
Antwort (Nicht-Streaming)
{
"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
| Ereignis | Beschreibung |
|---|---|
content | Textinhalt wird gestreamt |
tool_results | Verwendete Tools und ihre Ergebnisse |
status | Fortschrittsaktualisierungen |
warning | Warnungen (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)
| Tool | Beschreibung |
|---|---|
query_accounts | Konten suchen und filtern |
query_groups | Gruppen suchen und filtern |
query_owners | Eigentümer suchen und filtern |
query_applications | Anwendungen suchen und filtern |
Konfiguration (configuration Feature)
| Tool | Beschreibung |
|---|---|
query_campaign_rules | Campaign-Regeln suchen |
query_policies | Richtlinien suchen |
query_roles | Rollen suchen |
Campaigns (campaigns Feature)
| Tool | Beschreibung |
|---|---|
list_campaigns | Aktive Campaigns auflisten |
query_approvals | Genehmigungsstatus abfragen |
query_compliance | Compliance-Metriken abfragen |
Beispielabfragen
Sicherheitsfragen
{
"message": "Find accounts with high threat levels and no MFA",
"stream": true
}Zugriffskontrolle
{
"message": "Which users have access to critical applications?",
"stream": true
}Compliance
{
"message": "Show me accounts with policy violations",
"stream": true
}Analytik
{
"message": "What department has the most inactive accounts?",
"stream": true
}Konversationskontext
Der AI-Assistent behält den Konversationskontext über den history-Parameter bei:
{
"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:
- Master Toggle - Globales AI-Aktivieren/Deaktivieren
- Feature-Berechtigungen - Granulare Kontrolle pro Feature-Gruppe
- 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
| Statuscode | Beschreibung |
|---|---|
400 | Bad Request - Ungültiges Nachrichtenformat |
401 | Unauthorized - Authentifizierung erforderlich |
403 | Forbidden - AI-Funktionen deaktiviert oder unzureichende Berechtigungen |
429 | Too Many Requests - Ratenlimit überschritten |
500 | Internal Server Error |
Fehlerantwortformat
{
"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
- AI Search - Benutzerhandbuch
- AI Assistant Settings - Konfigurationshandbuch
- API Reference - Vollständiger API-Index
