Create a tool policy

POST/api/companies/{companyId}/tools/policies
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

Create a tool policy.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

namestringRequired1–160 characters
descriptionstring | nullOptionalat most 4000 characters
policyTypestringRequiredone of: "allow", "block", "require_approval", "trust_rule", "rate_limit"
priorityintegerOptional≥ 0≤ 10000
enabledbooleanOptional
selectorsobjectOptional
conditionsobject | nullOptional
conditions.argumentsobjectOptional
conditions.arguments.fieldEqualsobjectOptional
conditions.arguments.fieldNotEqualsobjectOptional
conditions.arguments.fieldInobject<string, array<any>>Optional
conditions.arguments.fieldMatchesobject<string, string>Optional
conditions.arguments.fieldExistsarray<string>Optionaleach at most 120 characters
conditions.arguments.fieldAbsentarray<string>Optionaleach at most 120 characters
conditions.argsobjectOptional
conditions.args.fieldEqualsobjectOptional
conditions.args.fieldNotEqualsobjectOptional
conditions.args.fieldInobject<string, array<any>>Optional
conditions.args.fieldMatchesobject<string, string>Optional
conditions.args.fieldExistsarray<string>Optionaleach at most 120 characters
conditions.args.fieldAbsentarray<string>Optionaleach at most 120 characters
conditions.actorobjectOptional
conditions.actor.actorTypestringOptionalone of: "agent", "user", "system", "plugin"
conditions.actor.actorTypesarray<string>Optionalitems one of: "agent", "user", "system", "plugin"
conditions.actor.agentIdstring (uuid)Optional
conditions.actor.agentIdsarray<string (uuid)>Optional
conditions.contextobjectOptional
conditions.context.projectIdstring (uuid)Optional
conditions.context.projectIdsarray<string (uuid)>Optional
conditions.context.routineIdstring (uuid)Optional
conditions.context.routineIdsarray<string (uuid)>Optional
conditions.context.issueIdstring (uuid)Optional
conditions.context.issueIdsarray<string (uuid)>Optional
conditions.context.requireIssuebooleanOptional
conditions.context.requireProjectbooleanOptional
conditions.context.requireRoutinebooleanOptional
conditions.riskobjectOptional
conditions.risk.levelsarray<string>Optionalitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.maxstringOptionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.isWritebooleanOptional
conditions.risk.isDestructivebooleanOptional
conditions.credentialScopeobjectOptional
conditions.credentialScope.applicationIdstring (uuid)Optional
conditions.credentialScope.applicationIdsarray<string (uuid)>Optional
conditions.credentialScope.connectionIdstring (uuid)Optional
conditions.credentialScope.connectionIdsarray<string (uuid)>Optional
conditions.credentialScope.catalogEntryIdstring (uuid)Optional
conditions.credentialScope.catalogEntryIdsarray<string (uuid)>Optional
conditions.credentialScope.applicationKeystringOptional1–160 characters
conditions.credentialScope.applicationKeysarray<string>Optionaleach at most 160 characters
conditions.credentialScope.providerTypestringOptional1–160 characters
conditions.credentialScope.providerTypesarray<string>Optionaleach at most 160 characters
conditions.trustBoundaryobjectOptional
conditions.trustBoundary.providerTypestringOptional1–160 characters
conditions.trustBoundary.providerTypesarray<string>Optionaleach at most 160 characters
conditions.trustBoundary.applicationKeystringOptional1–160 characters
conditions.trustBoundary.applicationKeysarray<string>Optionaleach at most 160 characters
conditions.trustBoundary.remoteHttpOnlybooleanOptional
conditions.trustBoundary.veyraSelfOnlybooleanOptional
conditions.timeWindowobjectOptional
conditions.timeWindow.startAtstring (date-time)Optional
conditions.timeWindow.endAtstring (date-time)Optional
conditions.timeWindow.daysOfWeekUtcarray<integer>Optional
conditions.timeWindow.startHourUtcintegerOptional≥ 0≤ 23
conditions.timeWindow.endHourUtcintegerOptional≥ 0≤ 24
configobject | nullOptional

Responses

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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Connectors