Справочник API публикуется на английском языке.
Test tool policy decision
POST
/api/companies/{companyId}/tools/policy/testPersonal API keyAgent API keyConsole session
Test tool policy decision.
Авторизация
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. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
companyIdstring (uuid)Обязательный
actorobjectОбязательный
actor.actorTypestringОбязательный
one of: "agent", "user", "system", "plugin"actor.actorIdstringОбязательный
1–240 charactersactor.agentIdstring (uuid) | nullНеобязательный
runContextobject | nullНеобязательный
runContext.heartbeatRunIdstring (uuid) | nullНеобязательный
runContext.issueIdstring (uuid) | nullНеобязательный
runContext.projectIdstring (uuid) | nullНеобязательный
runContext.routineIdstring (uuid) | nullНеобязательный
runContext.gatewayIdstring (uuid) | nullНеобязательный
runContext.gatewayPublicIdstring | nullНеобязательный
1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$runContext.gatewayTokenIdstring (uuid) | nullНеобязательный
runContext.clientSubjectTypestring | nullНеобязательный
one of: "gateway_client", "heartbeat_run", "board_user", "agent"runContext.clientSubjectIdstring | nullНеобязательный
1–240 charactersrunContext.clientNamestring | nullНеобязательный
1–160 charactersrunContext.externalClientboolean | nullНеобязательный
requestobjectОбязательный
request.applicationIdstring (uuid) | nullНеобязательный
request.connectionIdstring (uuid) | nullНеобязательный
request.catalogEntryIdstring (uuid) | nullНеобязательный
request.toolNamestringОбязательный
1–240 charactersrequest.argumentsanyНеобязательный
request.idempotencyKeystring | nullНеобязательный
1–512 charactersrequest.sideEffectingbooleanНеобязательный
consumeRateLimitbooleanНеобязательный
writeAuditEventbooleanНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.