Settings Endpoints

The Settings API provides endpoints for managing Hydden.Control configuration, including integration settings and AI features.

Base URL

All endpoints are relative to /api/v1/settings.

---

Hydden Integration Settings

Get Hydden Settings

Retrieve the current Hydden platform integration settings.

GET /api/v1/settings/hydden

::: note Administrator Only This endpoint requires Administrator role. :::

Response

{
  "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"
}

Update Hydden Settings

Update the Hydden platform integration settings.

PUT /api/v1/settings/hydden

::: note Administrator Only This endpoint requires Administrator role. :::

Request Body

{
  "client_id": "hydden-client-123",
  "client_secret": "new-secret-value",
  "target_platform": "production"
}

Response

Returns the updated settings object.

Delete Hydden Settings

Remove the Hydden platform integration settings.

DELETE /api/v1/settings/hydden

::: note Administrator Only This endpoint requires Administrator role. :::

Response

Returns 204 No Content on success.

---

AI Settings

Get AI Layout

Retrieve AI feature availability summary.

GET /api/v1/settings/ai/layout

::: note Administrator Only This endpoint requires Administrator role. :::

Response

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

Get AI Settings

Retrieve the master AI toggle status.

GET /api/v1/settings/ai

::: note Administrator Only This endpoint requires Administrator role. :::

Response

{
  "enabled": true
}

Update AI Settings

Update the master AI toggle.

PUT /api/v1/settings/ai

::: note Administrator Only This endpoint requires Administrator role. :::

Request Body

{
  "enabled": true
}

Response

Returns the updated status.

---

AI Feature Permissions

Get AI Feature Permissions

Retrieve permissions for individual AI features.

GET /api/v1/settings/ai/features

::: note Administrator Only This endpoint requires Administrator role. :::

Response

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

Feature Groups

Feature	Description
identity_data	AI queries for accounts, groups, owners, applications
configuration	AI assistance for campaign rules, policies, roles
campaigns	AI operations for campaign management and approvals

Update Feature Permission

Update permission for a specific AI feature.

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

::: note Administrator Only This endpoint requires Administrator role. :::

Path Parameters

Parameter	Type	Description
feature	string	Feature name (identity_data, configuration, campaigns)

Request Body

{
  "enabled": true
}

Response

Returns the updated permission status.

---

User Preferences

User preferences control each user's personal interface settings. These endpoints do not require administrator role — they operate on the authenticated user's own data.

Base path: /api/v1/user/preferences

Get User Preferences

Retrieve the preferences for the currently signed-in user.

GET /api/v1/user/preferences

Response (200):

{
  "theme": "dark",
  "review_columns": ["user", "risk", "privilege", "signals", "application", "activity", "owner", "status"],
  "review_detail_sections": ["ai_recommendations", "owner_details", "account_details", "risk_factors", "entitlements", "previous_decisions", "similar_accounts", "audit_trail"]
}

Response fields:

Field	Type	Description
theme	string	"light" or "dark"
review_columns	string[]	Column IDs shown in the campaign review table
review_detail_sections	string[]	Section IDs shown in the account detail panel

---

Update User Preferences

Update one or more preferences for the currently signed-in user. Send only the fields you want to change.

PUT /api/v1/user/preferences

Request body (all fields optional):

{
  "theme": "dark",
  "review_columns": ["user", "risk", "status", "department"],
  "review_detail_sections": ["ai_recommendations", "entitlements", "previous_decisions"]
}

Response (200): Returns the full updated preferences object.

Valid column IDs (for review_columns):

Category	Column IDs
Review	user, risk, privilege, signals, application, activity, owner, status, manager, reviewed
Identity	account_name, display_name, email, upn, employee_id, domain
Organization	department, title, cost_center, location, country
Account	account_type, account_platform, classification, data_source_name, data_source_platform, provider, mapped_to, mapped_owners
Security	threat_level, total_threat, risk_score, mfa_status, password_age, login_age, last_login_date, compliance_status, managed_by_pam, vault_safe
Risk	privilege_total, breach_data_total, account_activity_total, group_membership_total, password_security_total, account_group_deviation, shared_accounts, compromise_name

::: note Required columns user and status are always shown regardless of the review_columns value. They cannot be removed. :::

Valid section IDs (for review_detail_sections):

Section ID	Description
ai_recommendations	AI-generated suggestion with confidence and reasoning
owner_details	Owner profile and role analysis
account_details	Department, platform, MFA, last login
risk_factors	Triggered risk factors and policy check results
entitlements	Group memberships and application role assignments
previous_decisions	Review history across past campaigns
similar_accounts	Accounts with matching access patterns
audit_trail	Change history for the account

---

Error Responses

Status Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Setting does not exist
500	Internal Server Error

---

Related Topics

• Integration Settings - User guide
• AI Assistant - AI configuration guide
• Preferences - User preferences guide
• API Reference - Complete API index