Skip to content

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.

http
GET /api/v1/settings/hydden

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

Antwort

json
{
  "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.

http
PUT /api/v1/settings/hydden

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

Request Body

json
{
  "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.

http
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.

http
GET /api/v1/settings/ai/layout

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

Antwort

json
{
  "ai_enabled": true,
  "identity_data_enabled": true
}

AI-Einstellungen abrufen

Ruft den Master-AI-Toggle-Status ab.

http
GET /api/v1/settings/ai

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

Antwort

json
{
  "enabled": true
}

AI-Einstellungen aktualisieren

Aktualisiert den Master-AI-Toggle.

http
PUT /api/v1/settings/ai

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

Request Body

json
{
  "enabled": true
}

Antwort

Gibt den aktualisierten Status zurück.


AI-Feature-Berechtigungen

AI-Feature-Berechtigungen abrufen

Ruft Berechtigungen für einzelne AI-Features ab.

http
GET /api/v1/settings/ai/features

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

Antwort

json
{
  "identity_data": true,
  "configuration": true,
  "campaigns": false
}

Feature-Gruppen

FeatureBeschreibung
identity_dataAI-Abfragen für Konten, Gruppen, Eigentümer, Anwendungen
configurationAI-Unterstützung für Campaign-Regeln, Richtlinien, Rollen
campaignsAI-Operationen für Campaign-Verwaltung und Genehmigungen

Feature-Berechtigung aktualisieren

Aktualisiert die Berechtigung für ein bestimmtes AI-Feature.

http
PUT /api/v1/settings/ai/features/{feature}

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

Path-Parameter

ParameterTypBeschreibung
featurestringFeature-Name (identity_data, configuration, campaigns)

Request Body

json
{
  "enabled": true
}

Antwort

Gibt den aktualisierten Berechtigungsstatus zurück.


Fehlerantworten

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

Verwandte Themen

Hydden Documentation and Training Hub