La référence de l'API est publiée en anglais.
Test tool policy decision
POST
/api/companies/{companyId}/tools/policy/testPersonal API keyAgent API keyConsole session
Test tool policy decision.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Corps de la requête
application/json · obligatoire
companyIdstring (uuid)Obligatoire
actorobjectObligatoire
actor.actorTypestringObligatoire
one of: "agent", "user", "system", "plugin"actor.actorIdstringObligatoire
1–240 charactersactor.agentIdstring (uuid) | nullFacultatif
runContextobject | nullFacultatif
runContext.heartbeatRunIdstring (uuid) | nullFacultatif
runContext.issueIdstring (uuid) | nullFacultatif
runContext.projectIdstring (uuid) | nullFacultatif
runContext.routineIdstring (uuid) | nullFacultatif
runContext.gatewayIdstring (uuid) | nullFacultatif
runContext.gatewayPublicIdstring | nullFacultatif
1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$runContext.gatewayTokenIdstring (uuid) | nullFacultatif
runContext.clientSubjectTypestring | nullFacultatif
one of: "gateway_client", "heartbeat_run", "board_user", "agent"runContext.clientSubjectIdstring | nullFacultatif
1–240 charactersrunContext.clientNamestring | nullFacultatif
1–160 charactersrunContext.externalClientboolean | nullFacultatif
requestobjectObligatoire
request.applicationIdstring (uuid) | nullFacultatif
request.connectionIdstring (uuid) | nullFacultatif
request.catalogEntryIdstring (uuid) | nullFacultatif
request.toolNamestringObligatoire
1–240 charactersrequest.argumentsanyFacultatif
request.idempotencyKeystring | nullFacultatif
1–512 charactersrequest.sideEffectingbooleanFacultatif
consumeRateLimitbooleanFacultatif
writeAuditEventbooleanFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.