La referencia de la API se publica en inglés.

Create a tool policy

POST/api/companies/{companyId}/tools/policies
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 4 · Historial

Create a tool policy.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

namestringObligatorio1–160 characters
descriptionstring | nullOpcionalat most 4000 characters
policyTypestringObligatorioone of: "allow", "block", "require_approval", "trust_rule", "rate_limit"
priorityintegerOpcional≥ 0≤ 10000
enabledbooleanOpcional
selectorsobjectOpcional
conditionsobject | nullOpcional
conditions.argumentsobjectOpcional
conditions.arguments.fieldEqualsobjectOpcional
conditions.arguments.fieldNotEqualsobjectOpcional
conditions.arguments.fieldInobject<string, array<any>>Opcional
conditions.arguments.fieldMatchesobject<string, string>Opcional
conditions.arguments.fieldExistsarray<string>Opcionaleach at most 120 characters
conditions.arguments.fieldAbsentarray<string>Opcionaleach at most 120 characters
conditions.argsobjectOpcional
conditions.args.fieldEqualsobjectOpcional
conditions.args.fieldNotEqualsobjectOpcional
conditions.args.fieldInobject<string, array<any>>Opcional
conditions.args.fieldMatchesobject<string, string>Opcional
conditions.args.fieldExistsarray<string>Opcionaleach at most 120 characters
conditions.args.fieldAbsentarray<string>Opcionaleach at most 120 characters
conditions.actorobjectOpcional
conditions.actor.actorTypestringOpcionalone of: "agent", "user", "system", "plugin"
conditions.actor.actorTypesarray<string>Opcionalitems one of: "agent", "user", "system", "plugin"
conditions.actor.agentIdstring (uuid)Opcional
conditions.actor.agentIdsarray<string (uuid)>Opcional
conditions.contextobjectOpcional
conditions.context.projectIdstring (uuid)Opcional
conditions.context.projectIdsarray<string (uuid)>Opcional
conditions.context.routineIdstring (uuid)Opcional
conditions.context.routineIdsarray<string (uuid)>Opcional
conditions.context.issueIdstring (uuid)Opcional
conditions.context.issueIdsarray<string (uuid)>Opcional
conditions.context.requireIssuebooleanOpcional
conditions.context.requireProjectbooleanOpcional
conditions.context.requireRoutinebooleanOpcional
conditions.riskobjectOpcional
conditions.risk.levelsarray<string>Opcionalitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.maxstringOpcionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.isWritebooleanOpcional
conditions.risk.isDestructivebooleanOpcional
conditions.credentialScopeobjectOpcional
conditions.credentialScope.applicationIdstring (uuid)Opcional
conditions.credentialScope.applicationIdsarray<string (uuid)>Opcional
conditions.credentialScope.connectionIdstring (uuid)Opcional
conditions.credentialScope.connectionIdsarray<string (uuid)>Opcional
conditions.credentialScope.catalogEntryIdstring (uuid)Opcional
conditions.credentialScope.catalogEntryIdsarray<string (uuid)>Opcional
conditions.credentialScope.applicationKeystringOpcional1–160 characters
conditions.credentialScope.applicationKeysarray<string>Opcionaleach at most 160 characters
conditions.credentialScope.providerTypestringOpcional1–160 characters
conditions.credentialScope.providerTypesarray<string>Opcionaleach at most 160 characters
conditions.trustBoundaryobjectOpcional
conditions.trustBoundary.providerTypestringOpcional1–160 characters
conditions.trustBoundary.providerTypesarray<string>Opcionaleach at most 160 characters
conditions.trustBoundary.applicationKeystringOpcional1–160 characters
conditions.trustBoundary.applicationKeysarray<string>Opcionaleach at most 160 characters
conditions.trustBoundary.remoteHttpOnlybooleanOpcional
conditions.trustBoundary.veyraSelfOnlybooleanOpcional
conditions.timeWindowobjectOpcional
conditions.timeWindow.startAtstring (date-time)Opcional
conditions.timeWindow.endAtstring (date-time)Opcional
conditions.timeWindow.daysOfWeekUtcarray<integer>Opcional
conditions.timeWindow.startHourUtcintegerOpcional≥ 0≤ 23
conditions.timeWindow.endHourUtcintegerOpcional≥ 0≤ 24
configobject | nullOpcional

Respuestas

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).

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Connectors