Справочник API публикуется на английском языке.
Create a tool trust rule from an action request
POST
/api/companies/{companyId}/tools/action-requests/{actionRequestId}/trust-rulePersonal API keyConsole session
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 charactersdescriptionstring | nullНеобязательный
at most 4000 characterspriorityintegerНеобязательный
≥ 0≤ 10000approvalThresholdintegerНеобязательный
≥ 1≤ 50selectorsobjectНеобязательный
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 charactersselectors.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 charactersselectors.clientNamesarray<string>Необязательный
each at most 160 charactersselectors.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 charactersselectors.toolNamesarray<string>Необязательный
each at most 240 charactersselectors.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 charactersargumentFilters.fieldAbsentarray<string>Необязательный
each at most 120 charactersexpiresAtstring (date-time) | nullНеобязательный
batchApprovalobject | nullНеобязательный
batchApproval.enabledbooleanНеобязательный
batchApproval.maxBatchSizeintegerНеобязательный
> 0≤ 100batchApproval.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. Подробнее: ошибки и ограничения.