preferences
Operations of the User Hub API. Paths are relative to your deployment's API host.
GET /api/user-hub-api/preferences
Get all preferences for the current user
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
scope | query | one of "global", "project" | no | Preference scope |
scopeId | query | string | no | Scope ID (e.g. project ID or org ID) |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PreferenceResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
PUT /api/user-hub-api/preferences
Upsert one or more preferences
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json SetPreferencesDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json PreferenceResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/user-hub-api/preferences/sync
Bulk sync preferences with last-write-wins merge
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json SyncPreferencesDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json SyncResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/user-hub-api/preferences/{key}
Get a single preference by key
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | |
scope | query | one of "global", "project" | no | Preference scope |
scopeId | query | string | no | Scope ID (e.g. project ID or org ID) |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PreferenceResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
DELETE /api/user-hub-api/preferences/{key}
Delete a single preference by key
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | |
scope | query | one of "global", "project" | no | |
scopeId | query | string | no |
| Status | Description | Body |
|---|---|---|
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |