帳號與工作空間
更新使用者資料
更改已登入使用者自己的資料(display_name、timezone、avatar_url、theme)。僅傳送需要更改的欄位。
POST /identity-api/user/profile/update契約檢閱日期: · sha256:563d2d581da0ad29
概覽
更改已登入使用者自己的資料(display_name、timezone、avatar_url、theme)。僅傳送需要更改的欄位。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
display_name | string選填/項目 |
|
timezone | string選填/項目 |
|
avatar_url | string選填/項目 |
|
theme | string選填/項目 |
|
expected_version | integer選填/項目 | 選填。您讀取到的版本。如其之後發生變化,更新會以 409 VERSION_CONFLICT 失敗,不會覆蓋。
|
include_version | boolean選填/項目 | 選填。true 會將資源版本加入回應。 — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"display_name": {
"type": "string",
"minLength": 0,
"maxLength": 120
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"avatar_url": {
"type": "string",
"minLength": 0,
"maxLength": 2048
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"expected_version": {
"description": "Optional. The version you read. If it changed since, the update fails with 409 VERSION_CONFLICT instead of overwriting.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"include_version": {
"description": "Optional. true adds the resource version to the answer.",
"type": "boolean"
}
},
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: synchronous_http_response.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
action | string在父物件中必填 |
|
profile | object在父物件中必填 | — |
profile.user_id | string在父物件中必填 |
|
profile.display_name | string | null在父物件中必填 | — |
profile.display_nameanyOf 1 | string在父物件中必填 | — |
profile.display_nameanyOf 2 | null在父物件中必填 | — |
profile.timezone | string | null在父物件中必填 | — |
profile.timezoneanyOf 1 | string在父物件中必填 | — |
profile.timezoneanyOf 2 | null在父物件中必填 | — |
profile.avatar_url | string | null在父物件中必填 | — |
profile.avatar_urlanyOf 1 | string在父物件中必填 | — |
profile.avatar_urlanyOf 2 | null在父物件中必填 | — |
profile.avatar_preview_url | string | null選填/項目 | — |
profile.avatar_preview_urlanyOf 1 | string選填/項目 |
|
profile.avatar_preview_urlanyOf 2 | null選填/項目 | — |
profile.avatar_preview_expires_at | string | null選填/項目 | — |
profile.avatar_preview_expires_atanyOf 1 | string選填/項目 |
|
profile.avatar_preview_expires_atanyOf 2 | null選填/項目 | — |
profile.theme | string | null在父物件中必填 | — |
profile.themeanyOf 1 | string在父物件中必填 |
|
profile.themeanyOf 2 | null在父物件中必填 | — |
profile.created_at | string | null在父物件中必填 | — |
profile.created_atanyOf 1 | string在父物件中必填 | — |
profile.created_atanyOf 2 | null在父物件中必填 | — |
profile.updated_at | string | null在父物件中必填 | — |
profile.updated_atanyOf 1 | string在父物件中必填 | — |
profile.updated_atanyOf 2 | null在父物件中必填 | — |
profile.deletion_scheduled_at | string | null在父物件中必填 | — |
profile.deletion_scheduled_atanyOf 1 | string在父物件中必填 | — |
profile.deletion_scheduled_atanyOf 2 | null在父物件中必填 | — |
profile.hard_delete_at | string | null在父物件中必填 | — |
profile.hard_delete_atanyOf 1 | string在父物件中必填 | — |
profile.hard_delete_atanyOf 2 | null在父物件中必填 | — |
profile.version | integer選填/項目 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "update"
},
"profile": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatar_preview_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"avatar_preview_expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"theme": {
"anyOf": [
{
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deletion_scheduled_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hard_delete_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"user_id",
"display_name",
"timezone",
"avatar_url",
"theme",
"created_at",
"updated_at",
"deletion_scheduled_at",
"hard_delete_at"
]
}
},
"required": [
"action",
"profile"
]
}錯誤與安全重試
檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError;處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷,但不要保留憑證。先解決 401/403 存取錯誤再重試,並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx,先讀取現有結果。僅在支援時重複使用冪等鍵;重試行為因操作而異,並不保證恰好傳送一次。
故障排查指南範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材,並將日期替換為已確認的發布時間。提交寫入前,請檢查帳號資格。本頁不會傳送 API 請求。
在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證,且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入,並由 CLI 更新憑證。
request.json
{}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/update" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/update", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /identity-api/user/profile/update < request.json合成回應範例
{
"action": "update",
"profile": {
"user_id": "11111111-1111-4111-8111-111111111111",
"display_name": null,
"timezone": null,
"avatar_url": null,
"theme": null,
"created_at": null,
"updated_at": null,
"deletion_scheduled_at": null,
"hard_delete_at": null
}
}