身分驗證引導
代理程式驗證:request
啟動代理程式登入,讓使用者開啟瀏覽器並選擇授權內容。此端點不在 api post 允許清單中。請將登入工作階段詳細資料保密。
POST /identity-api/agent-auth/request契約檢閱日期: · sha256:563d2d581da0ad29
概覽
啟動代理程式登入,讓使用者開啟瀏覽器並選擇授權內容。此端點不在 api post 允許清單中。請將登入工作階段詳細資料保密。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
此端點屬於登入通訊協定,無法透過 api post 使用。請使用支援的瀏覽器登入流程,避免在輸出與日誌中暴露工作階段憑證。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
client_name | string在父物件中必填 |
|
device_name | string在父物件中必填 |
|
callback_uri | string在父物件中必填 | — |
callback_urianyOf 1 | string在父物件中必填 |
|
callback_urianyOf 2 | string在父物件中必填 |
|
callback_state | string在父物件中必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"client_name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"device_name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"callback_uri": {
"anyOf": [
{
"type": "string",
"const": "http://127.0.0.1:8789/grant/callback"
},
{
"type": "string",
"maxLength": 2048,
"format": "uri",
"pattern": "^https:\\/\\/.*"
}
]
},
"callback_state": {
"type": "string",
"minLength": 32,
"maxLength": 256
}
},
"required": [
"client_name",
"device_name",
"callback_uri",
"callback_state"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: not_agent_callable.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
request_id | string在父物件中必填 |
|
approval_url | string在父物件中必填 |
|
expires_in | integer在父物件中必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"request_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)$"
},
"approval_url": {
"type": "string",
"format": "uri"
},
"expires_in": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"approval_url",
"expires_in"
]
}錯誤與安全重試
檢查 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
{
"client_name": "example",
"device_name": "example",
"callback_uri": "http://127.0.0.1:8789/grant/callback",
"callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request" \
-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/agent-auth/request", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"client_name": "example",
"device_name": "example",
"callback_uri": "http://127.0.0.1:8789/grant/callback",
"callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.合成回應範例
{
"request_id": "11111111-1111-4111-8111-111111111111",
"approval_url": "https://example.com/media.png",
"expires_in": 1
}