API referansı İngilizce yayımlanır.
Test tool policy decision
POST
/api/companies/{companyId}/tools/policy/testPersonal API keyAgent API keyConsole session
Test tool policy decision.
Yetkilendirme
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Anahtarlar nasıl çalışır.
Yol parametreleri
companyIdstringZorunluThe organization's id.
İstek gövdesi
application/json · zorunlu
companyIdstring (uuid)Zorunlu
actorobjectZorunlu
actor.actorTypestringZorunlu
one of: "agent", "user", "system", "plugin"actor.actorIdstringZorunlu
1–240 charactersactor.agentIdstring (uuid) | nullİsteğe bağlı
runContextobject | nullİsteğe bağlı
runContext.heartbeatRunIdstring (uuid) | nullİsteğe bağlı
runContext.issueIdstring (uuid) | nullİsteğe bağlı
runContext.projectIdstring (uuid) | nullİsteğe bağlı
runContext.routineIdstring (uuid) | nullİsteğe bağlı
runContext.gatewayIdstring (uuid) | nullİsteğe bağlı
runContext.gatewayPublicIdstring | nullİsteğe bağlı
1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$runContext.gatewayTokenIdstring (uuid) | nullİsteğe bağlı
runContext.clientSubjectTypestring | nullİsteğe bağlı
one of: "gateway_client", "heartbeat_run", "board_user", "agent"runContext.clientSubjectIdstring | nullİsteğe bağlı
1–240 charactersrunContext.clientNamestring | nullİsteğe bağlı
1–160 charactersrunContext.externalClientboolean | nullİsteğe bağlı
requestobjectZorunlu
request.applicationIdstring (uuid) | nullİsteğe bağlı
request.connectionIdstring (uuid) | nullİsteğe bağlı
request.catalogEntryIdstring (uuid) | nullİsteğe bağlı
request.toolNamestringZorunlu
1–240 charactersrequest.argumentsanyİsteğe bağlı
request.idempotencyKeystring | nullİsteğe bağlı
1–512 charactersrequest.sideEffectingbooleanİsteğe bağlı
consumeRateLimitbooleanİsteğe bağlı
writeAuditEventbooleanİsteğe bağlı
Yanıtlar
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.