Справочник API публикуется на английском языке.

Create a tool trust rule from an action request

POST/api/companies/{companyId}/tools/action-requests/{actionRequestId}/trust-rule
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Create a tool trust rule from an action request.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.
actionRequestIdstringОбязательныйThe actionrequest's id.

Тело запроса

application/json · обязательно

argumentModestringНеобязательныйone of: "exact", "action"
namestringНеобязательный1–160 characters
descriptionstring | nullНеобязательныйat most 4000 characters
priorityintegerНеобязательный≥ 0≤ 10000
approvalThresholdintegerНеобязательный≥ 1≤ 50
selectorsobjectНеобязательный
selectors.actorTypestringНеобязательныйone of: "agent", "user", "system", "plugin"
selectors.agentIdstring (uuid)Необязательный
selectors.agentIdsarray<string (uuid)>Необязательный
selectors.projectIdstring (uuid)Необязательный
selectors.projectIdsarray<string (uuid)>Необязательный
selectors.routineIdstring (uuid)Необязательный
selectors.routineIdsarray<string (uuid)>Необязательный
selectors.issueIdstring (uuid)Необязательный
selectors.issueIdsarray<string (uuid)>Необязательный
selectors.gatewayIdstring (uuid)Необязательный
selectors.gatewayIdsarray<string (uuid)>Необязательный
selectors.gatewayPublicIdstringНеобязательный1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
selectors.gatewayPublicIdsarray<string>Необязательныйeach at most 120 characters
selectors.gatewayTokenIdstring (uuid)Необязательный
selectors.gatewayTokenIdsarray<string (uuid)>Необязательный
selectors.clientSubjectTypestringНеобязательныйone of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientSubjectTypesarray<string>Необязательныйitems one of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientNamestringНеобязательный1–160 characters
selectors.clientNamesarray<string>Необязательныйeach at most 160 characters
selectors.externalClientbooleanНеобязательный
selectors.applicationIdstring (uuid)Необязательный
selectors.applicationIdsarray<string (uuid)>Необязательный
selectors.connectionIdstring (uuid)Необязательный
selectors.connectionIdsarray<string (uuid)>Необязательный
selectors.catalogEntryIdstring (uuid)Необязательный
selectors.catalogEntryIdsarray<string (uuid)>Необязательный
selectors.toolNamestringНеобязательный1–240 characters
selectors.toolNamesarray<string>Необязательныйeach at most 240 characters
selectors.riskLevelstringНеобязательныйone of: "low", "medium", "high", "critical", "read", "write", "destructive"
selectors.riskLevelsarray<string>Необязательныйitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
scopeobjectНеобязательный
scope.includeAgentbooleanНеобязательный
scope.includeProjectbooleanНеобязательный
scope.includeIssuebooleanНеобязательный
scope.includeApplicationbooleanНеобязательный
scope.includeConnectionbooleanНеобязательный
scope.includeCatalogEntrybooleanНеобязательный
scope.includeToolbooleanНеобязательный
argumentFiltersobjectНеобязательный
argumentFilters.allowAnybooleanНеобязательный
argumentFilters.exactHashstring | nullНеобязательныйpattern: ^[a-f0-9]{64}$
argumentFilters.allowedHashesarray<string>Необязательный
argumentFilters.fieldEqualsobjectНеобязательный
argumentFilters.fieldNotEqualsobjectНеобязательный
argumentFilters.fieldInobject<string, array<any>>Необязательный
argumentFilters.fieldMatchesobject<string, string>Необязательный
argumentFilters.fieldExistsarray<string>Необязательныйeach at most 120 characters
argumentFilters.fieldAbsentarray<string>Необязательныйeach at most 120 characters
expiresAtstring (date-time) | nullНеобязательный
batchApprovalobject | nullНеобязательный
batchApproval.enabledbooleanНеобязательный
batchApproval.maxBatchSizeintegerНеобязательный> 0≤ 100
batchApproval.windowSecondsintegerНеобязательный> 0≤ 31536000

Ответы

201SuccessCreated; the body holds the new resource.
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. Подробнее: ошибки и ограничения.

Connectors