Skip to content

HTTP API / Profile

Profile API ​

5 operations. Paths are relative to the API host (http://localhost:5080 in local development). Every operation accepts an OIDC bearer token (Authorization: Bearer …) or a workspace API key (X-Api-Key: keel_live_…); errors are RFC 9457 Problem Details with a code (error codes). Permissions: matrix.

MethodPathSummary
PUT/api/v1/me/preferencesSave the caller's theme, time zone and number format.
GET/api/v1/me/profileThe caller's identity (from the IdP, read-only), role, sign-in method and preferences.
GET/api/v1/me/sessionsThe caller's own sign-in sessions in the IdP (Available is false when another IdP manages them).
POST/api/v1/me/sessions:sign-out-othersEnd every session of the caller except the current one; returns how many ended.
DELETE/api/v1/me/sessions/{sessionId}End one of the caller's other sessions (never another person's, never the current one).

UpdateMyPreferences ​

http
PUT /api/v1/me/preferences

Save the caller's theme, time zone and number format.

Request body (application/json): UpdatePreferencesRequest

FieldTypeNotes
numberFormatNumberFormatPreferenceOne of DotDecimal, CommaDecimal
themeThemePreferenceOne of System, Light, Dark
timeZonestring?
StatusDescriptionBody
204No Content—

GetMyProfile ​

http
GET /api/v1/me/profile

The caller's identity (from the IdP, read-only), role, sign-in method and preferences.

StatusDescriptionBody
200OKMyProfileResponse

Response 200: MyProfileResponse

FieldTypeNotes
displayNamestring
emailstring
preferencesUserPreferencesDto
rolestring?
sessionsAvailableboolean
signInMethodstring
userIduuid

ListMySessions ​

http
GET /api/v1/me/sessions

The caller's own sign-in sessions in the IdP (Available is false when another IdP manages them).

StatusDescriptionBody
200OKMySessionsResponse

Response 200: MySessionsResponse

FieldTypeNotes
availableboolean
sessionsMySessionDto[]

SignOutOtherSessions ​

http
POST /api/v1/me/sessions:sign-out-others

End every session of the caller except the current one; returns how many ended.

StatusDescriptionBody
200OKint32

SignOutMySession ​

http
DELETE /api/v1/me/sessions/{sessionId}

End one of the caller's other sessions (never another person's, never the current one).

ParameterInTypeRequiredNotes
sessionIdpathstringyes
StatusDescriptionBody
204No Content—

Anchor Keel is a working product name: one platform, a shared core and licensed modules (Keel Semantic, Keel Migrate). Documentation built from the repository — facts are derived from code, ADRs and the decisions log.