Fiókok és munkaterületek
API-kulcs létrehozása
Személyes hozzáférési kulcs létrehozása választott képességekkel (agent:operate, agent:publish, agent:engage), opcionális workspace_ids korláttal és legfeljebb 365 napos élettartammal; a titkos értéket egyszer adja vissza, később nem olvasható. Az ügynök csak a saját felhatalmazását adhatja tovább legfeljebb 30 napra, és a kulcs az engedély lejártakor leáll. API-kulcsok kezelésére szóló engedély kell; PAT nem használhatja.
POST /identity-api/api-keys/createSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
Személyes hozzáférési kulcs létrehozása választott képességekkel (agent:operate, agent:publish, agent:engage), opcionális workspace_ids korláttal és legfeljebb 365 napos élettartammal; a titkos értéket egyszer adja vissza, később nem olvasható. Az ügynök csak a saját felhatalmazását adhatja tovább legfeljebb 30 napra, és a kulcs az engedély lejártakor leáll. API-kulcsok kezelésére szóló engedély kell; PAT nem használhatja.
Minden delegált engedélyhez legfeljebb 25 aktív kulcs tartozhat. A fölötte küldött kérések API_KEY_GRANT_KEY_LIMIT hibát adnak.
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ő |
|
name | stringA szülőn belül kötelező |
|
lifetime_days | integerOpcionális / elem | Napok a kulcs lejáratáig (1-365, alapérték 365). Delegált ügynök kulcsa soha nem élhet 30 napnál tovább.
|
capabilities | arrayOpcionális / elem | A kulcs megengedett műveletei. Bejelentkezett felhasználónál az alapérték operate, publish és engage. A delegált ügynök csak a saját felhatalmazását adhatja tovább (kulcskezelést soha).
|
capabilities[] | stringOpcionális / elem |
|
workspace_ids | arrayOpcionális / elem | Korlátozd a kulcsot ezekre a munkaterületekre. Kihagyva a felhasználó minden elérhető munkaterületére érvényes. A korlátozott kulcsnak az egyébként aktív munkaterületet használó útvonalakon meg kell neveznie a workspace_id értékét, és nem hívhat szervezetszintű olvasásokat.
|
workspace_ids[] | stringOpcionális / elem |
|
scopes | arrayOpcionális / elem | A capabilities elavult aliasa. Pontosan figyelembe veszi; az üres listát figyelmen kívül hagyja.
|
scopes[] | stringOpcionális / elem |
|
idempotency_key | stringOpcionális / elem | Opcionális. Biztonságos újrapróbáláshoz ugyanazt a kulcsot használd. A titkos érték egyszer látható: ha az újrapróbálás már létrehozott kulcsot talál, 409 IDEMPOTENT_REPLAY választ ad (a details.existing_key nevezi meg), nem mutatja meg újra. Vond vissza azt a kulcsot, és új idempotency_key értékkel hozz létre újat.
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"lifetime_days": {
"default": 365,
"description": "Days until the key expires (1-365, default 365). A key created by a delegated agent never lives longer than 30 days.",
"type": "integer",
"minimum": 1,
"maximum": 365
},
"capabilities": {
"description": "What the key may do. Defaults to operate, publish and engage for a signed-in user. A delegated agent can only grant what its own authorization holds (never key management).",
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:operate",
"agent:publish",
"agent:engage"
]
}
},
"workspace_ids": {
"description": "Limit the key to these Workspaces. Omit it for every Workspace the user can access. A limited key must name its Workspace (workspace_id) on routes that would otherwise use the active Workspace, and cannot call organization-wide reads.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"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)$"
}
},
"scopes": {
"description": "Deprecated alias of capabilities. It is honoured exactly; an empty list is ignored.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:operate",
"agent:publish",
"agent:engage"
]
}
},
"idempotency_key": {
"description": "Optional. Reuse the same key to retry safely. The secret is shown once: a retry that finds the key already created answers 409 IDEMPOTENT_REPLAY (details.existing_key names it) instead of showing it again. Revoke that key and create a new one with a new idempotency_key.",
"type": "string",
"minLength": 8,
"maxLength": 160,
"pattern": "^[!-~]+$"
}
},
"required": [
"name"
],
"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ő | — |
apiKey | objectA szülőn belül kötelező | — |
apiKey.id | stringA szülőn belül kötelező |
|
apiKey.name | stringA szülőn belül kötelező | — |
apiKey.last_4 | stringA szülőn belül kötelező | — |
apiKey.scopes | arrayA szülőn belül kötelező | — |
apiKey.scopes[] | stringOpcionális / elem | — |
apiKey.created_at | stringA szülőn belül kötelező |
|
apiKey.expires_at | string | nullA szülőn belül kötelező | — |
apiKey.expires_atanyOf 1 | stringA szülőn belül kötelező |
|
apiKey.expires_atanyOf 2 | nullA szülőn belül kötelező | — |
apiKey.last_used_at | string | nullA szülőn belül kötelező | — |
apiKey.last_used_atanyOf 1 | stringA szülőn belül kötelező |
|
apiKey.last_used_atanyOf 2 | nullA szülőn belül kötelező | — |
apiKey.revoked_at | string | nullA szülőn belül kötelező | — |
apiKey.revoked_atanyOf 1 | stringA szülőn belül kötelező |
|
apiKey.revoked_atanyOf 2 | nullA szülőn belül kötelező | — |
apiKey.status | stringA szülőn belül kötelező |
|
apiKey.replaces | object | nullA szülőn belül kötelező | — |
apiKey.replacesanyOf 1 | objectA szülőn belül kötelező | — |
apiKey.replaces.idanyOf 1 | stringA szülőn belül kötelező |
|
apiKey.replaces.nameanyOf 1 | stringA szülőn belül kötelező | — |
apiKey.replaces.last_4anyOf 1 | stringA szülőn belül kötelező | — |
apiKey.replaces.statusanyOf 1 | stringA szülőn belül kötelező |
|
apiKey.replacesanyOf 2 | nullA szülőn belül kötelező | — |
apiKey.replaced_by | arrayA szülőn belül kötelező | — |
apiKey.replaced_by[] | objectOpcionális / elem | — |
apiKey.replaced_by[].id | stringA szülőn belül kötelező |
|
apiKey.replaced_by[].name | stringA szülőn belül kötelező | — |
apiKey.replaced_by[].last_4 | stringA szülőn belül kötelező | — |
apiKey.replaced_by[].status | stringA szülőn belül kötelező |
|
apiKey.capabilities | arrayOpcionális / elem | — |
apiKey.capabilities[] | stringOpcionális / elem |
|
apiKey.workspace_ids | array | nullOpcionális / elem | — |
apiKey.workspace_idsanyOf 1 | arrayOpcionális / elem | — |
apiKey.workspace_ids[]anyOf 1 | stringOpcionális / elem |
|
apiKey.workspace_idsanyOf 2 | nullOpcionális / elem | — |
apiKey.created_by_delegated_grant_id | string | nullOpcionális / elem | — |
apiKey.created_by_delegated_grant_idanyOf 1 | stringOpcionális / elem |
|
apiKey.created_by_delegated_grant_idanyOf 2 | nullOpcionális / elem | — |
secret | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"apiKey": {
"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"
},
"last_4": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
},
"replaces": {
"anyOf": [
{
"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"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
]
},
{
"type": "null"
}
]
},
"replaced_by": {
"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"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
]
}
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:operate",
"agent:publish",
"agent:engage"
]
}
},
"workspace_ids": {
"anyOf": [
{
"type": "array",
"items": {
"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)$"
}
},
{
"type": "null"
}
]
},
"created_by_delegated_grant_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"last_4",
"scopes",
"created_at",
"expires_at",
"last_used_at",
"revoked_at",
"status",
"replaces",
"replaced_by"
]
},
"secret": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiKey",
"secret"
]
}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
{
"name": "example"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/api-keys/create" \
-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/api-keys/create", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"name": "example"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /identity-api/api-keys/create < request.jsonSzintetikus válaszpélda
{
"apiKey": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"last_4": "example",
"scopes": [],
"created_at": "2099-01-15T09:00:00Z",
"expires_at": null,
"last_used_at": null,
"revoked_at": null,
"status": "active",
"replaces": null,
"replaced_by": []
},
"secret": "example"
}