Fiókok és munkaterületek

API-kulcsok listázása

A felhasználó API-kulcsainak listázása (név, utolsó 4 karakter, állapot, lejárat, származási lánc); az include_authority megadásával a kulcsok képességei és munkaterület-korlátai is lekérhetők. Titkos értékeket soha nem ad vissza. API-kulcsok kezelésére szóló engedély kell hozzá; PAT nem használhatja.

POST /identity-api/api-keys/list

Szerződés ellenőrizve: 2026-10-21 · sha256:563d2d581da0ad29

Olvasás Markdown formátumban Nyilvános szerződés letöltése OpenAPI letöltése

Áttekintés

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

Elfogadott hitelesítőadat-osztályok: user_session, delegated_oauth
Delegált képesség: agent:manage_api_keys
Minimális munkaterületi szerepkör: Ez a szerződés nem határoz meg minimális munkaterületi szerepkört; a tulajdonosi és engedélyellenőrzések továbbra is érvényesek.
Hozzáférési hatókör: Fiókszintű jogosultság
Minden munkaterületre kiterjedő hozzájárulás szükséges: Igen
Állapotot módosít: Nem
A művelet befejezésekor: synchronous_http_response

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.

Kérésmezők
Mező / ág	Típus / kötelező	Korlátok
`$`	`object`A szülőn belül kötelező	`additionalProperties: false`
`include_revoked`	`boolean`Opcionális / elem	`default: false`
`include_authority`	`boolean`Opcionális / elem	Adja vissza a kulcsok képességeit, munkaterület-korlátját (null = minden munkaterület) és a létrehozó delegált engedélyt is. `default: false`

Teljes JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "include_revoked": {
      "default": false,
      "type": "boolean"
    },
    "include_authority": {
      "default": false,
      "description": "Also return each key's capabilities, Workspace limit (null = every Workspace) and the delegated grant that created it.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Válasz és befejezés

Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.

Válasz és befejezés
Mező / ág	Típus / kötelező	Korlátok
`$`	`object`A szülőn belül kötelező	—
`apiKeys`	`array`A szülőn belül kötelező	—
`apiKeys[]`	`object`Opcionális / elem	—
`apiKeys[].id`	`string`A szülőn belül kötelező	`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)$"`
`apiKeys[].name`	`string`A szülőn belül kötelező	—
`apiKeys[].last_4`	`string`A szülőn belül kötelező	—
`apiKeys[].scopes`	`array`A szülőn belül kötelező	—
`apiKeys[].scopes[]`	`string`Opcionális / elem	—
`apiKeys[].created_at`	`string`A szülőn belül kötelező	`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)))$"`
`apiKeys[].expires_at`	`string \| null`A szülőn belül kötelező	—
`apiKeys[].expires_at`anyOf 1	`string`A szülőn belül kötelező	`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)))$"`
`apiKeys[].expires_at`anyOf 2	`null`A szülőn belül kötelező	—
`apiKeys[].last_used_at`	`string \| null`A szülőn belül kötelező	—
`apiKeys[].last_used_at`anyOf 1	`string`A szülőn belül kötelező	`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)))$"`
`apiKeys[].last_used_at`anyOf 2	`null`A szülőn belül kötelező	—
`apiKeys[].revoked_at`	`string \| null`A szülőn belül kötelező	—
`apiKeys[].revoked_at`anyOf 1	`string`A szülőn belül kötelező	`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)))$"`
`apiKeys[].revoked_at`anyOf 2	`null`A szülőn belül kötelező	—
`apiKeys[].status`	`string`A szülőn belül kötelező	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`	`object \| null`A szülőn belül kötelező	—
`apiKeys[].replaces`anyOf 1	`object`A szülőn belül kötelező	—
`apiKeys[].replaces.id`anyOf 1	`string`A szülőn belül kötelező	`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)$"`
`apiKeys[].replaces.name`anyOf 1	`string`A szülőn belül kötelező	—
`apiKeys[].replaces.last_4`anyOf 1	`string`A szülőn belül kötelező	—
`apiKeys[].replaces.status`anyOf 1	`string`A szülőn belül kötelező	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`anyOf 2	`null`A szülőn belül kötelező	—
`apiKeys[].replaced_by`	`array`A szülőn belül kötelező	—
`apiKeys[].replaced_by[]`	`object`Opcionális / elem	—
`apiKeys[].replaced_by[].id`	`string`A szülőn belül kötelező	`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)$"`
`apiKeys[].replaced_by[].name`	`string`A szülőn belül kötelező	—
`apiKeys[].replaced_by[].last_4`	`string`A szülőn belül kötelező	—
`apiKeys[].replaced_by[].status`	`string`A szülőn belül kötelező	`enum: ["active","expired","revoked"]`
`apiKeys[].capabilities`	`array`Opcionális / elem	—
`apiKeys[].capabilities[]`	`string`Opcionális / elem	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKeys[].workspace_ids`	`array \| null`Opcionális / elem	—
`apiKeys[].workspace_ids`anyOf 1	`array`Opcionális / elem	—
`apiKeys[].workspace_ids[]`anyOf 1	`string`Opcionális / elem	`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)$"`
`apiKeys[].workspace_ids`anyOf 2	`null`Opcionális / elem	—
`apiKeys[].created_by_delegated_grant_id`	`string \| null`Opcionális / elem	—
`apiKeys[].created_by_delegated_grant_id`anyOf 1	`string`Opcionális / elem	`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)$"`
`apiKeys[].created_by_delegated_grant_id`anyOf 2	`null`Opcionális / elem	—

Teljes JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "apiKeys": {
      "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"
          },
          "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"
        ]
      }
    }
  },
  "required": [
    "apiKeys"
  ]
}

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/api-keys/list" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// 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/list", {
  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/api-keys/list < request.json

Szintetikus válaszpélda

{
  "apiKeys": []
}

MCP: sosoapi_list_api_keys

Minden API-művelet Hitelesítés és engedélyek