Fiókok és munkaterületek
Szervezeti kontextus lekérése
A szervezetek, munkaterületeik és csatornáik élő térképének olvasása azonosítókkal és szerepkörökkel. Akkor használd, ha szervezet- vagy csatornaazonosítók kellenek. Munkaterületi közzétételnél használd újra a visszakapott munkaterület-azonosítót; ne olvasd le külön a munkaterület-kontextust is.
POST /identity-api/agent/organization-contextSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
A szervezetek, munkaterületeik és csatornáik élő térképének olvasása azonosítókkal és szerepkörökkel. Akkor használd, ha szervezet- vagy csatornaazonosítók kellenek. Munkaterületi közzétételnél használd újra a visszakapott munkaterület-azonosítót; ne olvasd le külön a munkaterület-kontextust is.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
organization_id | stringOpcionális / elem |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organization_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)$"
}
},
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
contract_version | stringA szülőn belül kötelező |
|
organizations | arrayA szülőn belül kötelező |
|
organizations[] | objectOpcionális / elem | — |
organizations[].id | stringA szülőn belül kötelező |
|
organizations[].name | stringA szülőn belül kötelező |
|
organizations[].role | stringA szülőn belül kötelező |
|
organizations[].status | stringA szülőn belül kötelező |
|
organizations[].workspaces | arrayA szülőn belül kötelező |
|
organizations[].workspaces[] | objectOpcionális / elem | — |
organizations[].workspaces[].id | stringA szülőn belül kötelező |
|
organizations[].workspaces[].name | stringA szülőn belül kötelező |
|
organizations[].workspaces[].role | string | nullA szülőn belül kötelező | — |
organizations[].workspaces[].roleanyOf 1 | stringA szülőn belül kötelező |
|
organizations[].workspaces[].roleanyOf 2 | nullA szülőn belül kötelező | — |
organizations[].workspaces[].channels | arrayA szülőn belül kötelező |
|
organizations[].workspaces[].channels[] | objectOpcionális / elem | — |
organizations[].workspaces[].channels[].id | stringA szülőn belül kötelező |
|
organizations[].workspaces[].channels[].organization_id | stringA szülőn belül kötelező |
|
organizations[].workspaces[].channels[].workspace_id | stringA szülőn belül kötelező |
|
organizations[].workspaces[].channels[].platform | stringA szülőn belül kötelező |
|
organizations[].workspaces[].channels[].status | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "organization-agent-context/v1"
},
"organizations": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"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)$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
"status": {
"type": "string",
"enum": [
"active",
"deletion_pending",
"deleted"
]
},
"workspaces": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"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)$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"editor",
"reviewer",
"viewer"
]
},
{
"type": "null"
}
]
},
"channels": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"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)$"
},
"organization_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)$"
},
"workspace_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)$"
},
"platform": {
"type": "string",
"enum": [
"instagram",
"threads",
"facebook",
"youtube",
"x"
]
},
"status": {
"type": "string",
"enum": [
"setup_incomplete",
"attached",
"action_required",
"disconnected"
]
}
},
"required": [
"id",
"organization_id",
"workspace_id",
"platform",
"status"
]
}
}
},
"required": [
"id",
"name",
"role",
"channels"
]
}
}
},
"required": [
"id",
"name",
"role",
"status",
"workspaces"
]
}
}
},
"required": [
"contract_version",
"organizations"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. Ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent/organization-context" \
-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/organization-context", {
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/agent/organization-context < request.jsonSzintetikus válaszpélda
{
"contract_version": "organization-agent-context/v1",
"organizations": []
}