La référence de l'API est publiée en anglais.

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 TeamMis à jour le Version 3 · Historique

Create a tool trust rule from an action request.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.
actionRequestIdstringObligatoireThe actionrequest's id.

Corps de la requête

application/json · obligatoire

argumentModestringFacultatifone of: "exact", "action"
namestringFacultatif1–160 characters
descriptionstring | nullFacultatifat most 4000 characters
priorityintegerFacultatif≥ 0≤ 10000
approvalThresholdintegerFacultatif≥ 1≤ 50
selectorsobjectFacultatif
selectors.actorTypestringFacultatifone of: "agent", "user", "system", "plugin"
selectors.agentIdstring (uuid)Facultatif
selectors.agentIdsarray<string (uuid)>Facultatif
selectors.projectIdstring (uuid)Facultatif
selectors.projectIdsarray<string (uuid)>Facultatif
selectors.routineIdstring (uuid)Facultatif
selectors.routineIdsarray<string (uuid)>Facultatif
selectors.issueIdstring (uuid)Facultatif
selectors.issueIdsarray<string (uuid)>Facultatif
selectors.gatewayIdstring (uuid)Facultatif
selectors.gatewayIdsarray<string (uuid)>Facultatif
selectors.gatewayPublicIdstringFacultatif1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
selectors.gatewayPublicIdsarray<string>Facultatifeach at most 120 characters
selectors.gatewayTokenIdstring (uuid)Facultatif
selectors.gatewayTokenIdsarray<string (uuid)>Facultatif
selectors.clientSubjectTypestringFacultatifone of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientSubjectTypesarray<string>Facultatifitems one of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientNamestringFacultatif1–160 characters
selectors.clientNamesarray<string>Facultatifeach at most 160 characters
selectors.externalClientbooleanFacultatif
selectors.applicationIdstring (uuid)Facultatif
selectors.applicationIdsarray<string (uuid)>Facultatif
selectors.connectionIdstring (uuid)Facultatif
selectors.connectionIdsarray<string (uuid)>Facultatif
selectors.catalogEntryIdstring (uuid)Facultatif
selectors.catalogEntryIdsarray<string (uuid)>Facultatif
selectors.toolNamestringFacultatif1–240 characters
selectors.toolNamesarray<string>Facultatifeach at most 240 characters
selectors.riskLevelstringFacultatifone of: "low", "medium", "high", "critical", "read", "write", "destructive"
selectors.riskLevelsarray<string>Facultatifitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
scopeobjectFacultatif
scope.includeAgentbooleanFacultatif
scope.includeProjectbooleanFacultatif
scope.includeIssuebooleanFacultatif
scope.includeApplicationbooleanFacultatif
scope.includeConnectionbooleanFacultatif
scope.includeCatalogEntrybooleanFacultatif
scope.includeToolbooleanFacultatif
argumentFiltersobjectFacultatif
argumentFilters.allowAnybooleanFacultatif
argumentFilters.exactHashstring | nullFacultatifpattern: ^[a-f0-9]{64}$
argumentFilters.allowedHashesarray<string>Facultatif
argumentFilters.fieldEqualsobjectFacultatif
argumentFilters.fieldNotEqualsobjectFacultatif
argumentFilters.fieldInobject<string, array<any>>Facultatif
argumentFilters.fieldMatchesobject<string, string>Facultatif
argumentFilters.fieldExistsarray<string>Facultatifeach at most 120 characters
argumentFilters.fieldAbsentarray<string>Facultatifeach at most 120 characters
expiresAtstring (date-time) | nullFacultatif
batchApprovalobject | nullFacultatif
batchApproval.enabledbooleanFacultatif
batchApproval.maxBatchSizeintegerFacultatif> 0≤ 100
batchApproval.windowSecondsintegerFacultatif> 0≤ 31536000

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Connectors