Settings Endpoints
Die Settings API bietet Endpoints zur Verwaltung der Hydden.Control-Konfiguration, einschließlich Integrationseinstellungen und AI-Funktionen.
Basis-URL
Alle Endpoints sind relativ zu /api/v1/settings.
Hydden-Integrationseinstellungen
Hydden-Einstellungen abrufen
Ruft die aktuellen Hydden-Plattform-Integrationseinstellungen ab.
GET /api/v1/settings/hydden::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Antwort
{
"client_id": "hydden-client-123",
"client_secret": "********",
"target_platform": "production",
"api_url": "https://api.hydden.io",
"is_configured": true,
"last_validated": "2024-02-01T10:00:00Z"
}Hydden-Einstellungen aktualisieren
Aktualisiert die Hydden-Plattform-Integrationseinstellungen.
PUT /api/v1/settings/hydden::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Request Body
{
"client_id": "hydden-client-123",
"client_secret": "new-secret-value",
"target_platform": "production"
}Antwort
Gibt das aktualisierte Einstellungsobjekt zurück.
Hydden-Einstellungen löschen
Entfernt die Hydden-Plattform-Integrationseinstellungen.
DELETE /api/v1/settings/hydden::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Antwort
Gibt 204 No Content bei Erfolg zurück.
AI-Einstellungen
AI-Layout abrufen
Ruft Übersicht über AI-Funktionsverfügbarkeit ab.
GET /api/v1/settings/ai/layout::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Antwort
{
"ai_enabled": true,
"identity_data_enabled": true
}AI-Einstellungen abrufen
Ruft den Master-AI-Toggle-Status ab.
GET /api/v1/settings/ai::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Antwort
{
"enabled": true
}AI-Einstellungen aktualisieren
Aktualisiert den Master-AI-Toggle.
PUT /api/v1/settings/ai::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Request Body
{
"enabled": true
}Antwort
Gibt den aktualisierten Status zurück.
AI-Feature-Berechtigungen
AI-Feature-Berechtigungen abrufen
Ruft Berechtigungen für einzelne AI-Features ab.
GET /api/v1/settings/ai/features::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Antwort
{
"identity_data": true,
"configuration": true,
"campaigns": false
}Feature-Gruppen
| Feature | Beschreibung |
|---|---|
identity_data | AI-Abfragen für Konten, Gruppen, Eigentümer, Anwendungen |
configuration | AI-Unterstützung für Campaign-Regeln, Richtlinien, Rollen |
campaigns | AI-Operationen für Campaign-Verwaltung und Genehmigungen |
Feature-Berechtigung aktualisieren
Aktualisiert die Berechtigung für ein bestimmtes AI-Feature.
PUT /api/v1/settings/ai/features/{feature}::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::
Path-Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
feature | string | Feature-Name (identity_data, configuration, campaigns) |
Request Body
{
"enabled": true
}Antwort
Gibt den aktualisierten Berechtigungsstatus zurück.
Fehlerantworten
| Statuscode | Beschreibung |
|---|---|
400 | Bad Request - Ungültige Parameter |
401 | Unauthorized - Authentifizierung erforderlich |
403 | Forbidden - Unzureichende Berechtigungen |
404 | Not Found - Einstellung existiert nicht |
500 | Internal Server Error |
Verwandte Themen
- Integration Settings - Benutzerhandbuch
- AI Assistant - AI-Konfigurationshandbuch
- API Reference - Vollständiger API-Index
