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

Create a tool policy

POST/api/companies/{companyId}/tools/policies
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

Create a tool policy.

Autorisation

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

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

namestringObligatoire1–160 characters
descriptionstring | nullFacultatifat most 4000 characters
policyTypestringObligatoireone of: "allow", "block", "require_approval", "trust_rule", "rate_limit"
priorityintegerFacultatif≥ 0≤ 10000
enabledbooleanFacultatif
selectorsobjectFacultatif
conditionsobject | nullFacultatif
conditions.argumentsobjectFacultatif
conditions.arguments.fieldEqualsobjectFacultatif
conditions.arguments.fieldNotEqualsobjectFacultatif
conditions.arguments.fieldInobject<string, array<any>>Facultatif
conditions.arguments.fieldMatchesobject<string, string>Facultatif
conditions.arguments.fieldExistsarray<string>Facultatifeach at most 120 characters
conditions.arguments.fieldAbsentarray<string>Facultatifeach at most 120 characters
conditions.argsobjectFacultatif
conditions.args.fieldEqualsobjectFacultatif
conditions.args.fieldNotEqualsobjectFacultatif
conditions.args.fieldInobject<string, array<any>>Facultatif
conditions.args.fieldMatchesobject<string, string>Facultatif
conditions.args.fieldExistsarray<string>Facultatifeach at most 120 characters
conditions.args.fieldAbsentarray<string>Facultatifeach at most 120 characters
conditions.actorobjectFacultatif
conditions.actor.actorTypestringFacultatifone of: "agent", "user", "system", "plugin"
conditions.actor.actorTypesarray<string>Facultatifitems one of: "agent", "user", "system", "plugin"
conditions.actor.agentIdstring (uuid)Facultatif
conditions.actor.agentIdsarray<string (uuid)>Facultatif
conditions.contextobjectFacultatif
conditions.context.projectIdstring (uuid)Facultatif
conditions.context.projectIdsarray<string (uuid)>Facultatif
conditions.context.routineIdstring (uuid)Facultatif
conditions.context.routineIdsarray<string (uuid)>Facultatif
conditions.context.issueIdstring (uuid)Facultatif
conditions.context.issueIdsarray<string (uuid)>Facultatif
conditions.context.requireIssuebooleanFacultatif
conditions.context.requireProjectbooleanFacultatif
conditions.context.requireRoutinebooleanFacultatif
conditions.riskobjectFacultatif
conditions.risk.levelsarray<string>Facultatifitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.maxstringFacultatifone of: "low", "medium", "high", "critical", "read", "write", "destructive"
conditions.risk.isWritebooleanFacultatif
conditions.risk.isDestructivebooleanFacultatif
conditions.credentialScopeobjectFacultatif
conditions.credentialScope.applicationIdstring (uuid)Facultatif
conditions.credentialScope.applicationIdsarray<string (uuid)>Facultatif
conditions.credentialScope.connectionIdstring (uuid)Facultatif
conditions.credentialScope.connectionIdsarray<string (uuid)>Facultatif
conditions.credentialScope.catalogEntryIdstring (uuid)Facultatif
conditions.credentialScope.catalogEntryIdsarray<string (uuid)>Facultatif
conditions.credentialScope.applicationKeystringFacultatif1–160 characters
conditions.credentialScope.applicationKeysarray<string>Facultatifeach at most 160 characters
conditions.credentialScope.providerTypestringFacultatif1–160 characters
conditions.credentialScope.providerTypesarray<string>Facultatifeach at most 160 characters
conditions.trustBoundaryobjectFacultatif
conditions.trustBoundary.providerTypestringFacultatif1–160 characters
conditions.trustBoundary.providerTypesarray<string>Facultatifeach at most 160 characters
conditions.trustBoundary.applicationKeystringFacultatif1–160 characters
conditions.trustBoundary.applicationKeysarray<string>Facultatifeach at most 160 characters
conditions.trustBoundary.remoteHttpOnlybooleanFacultatif
conditions.trustBoundary.veyraSelfOnlybooleanFacultatif
conditions.timeWindowobjectFacultatif
conditions.timeWindow.startAtstring (date-time)Facultatif
conditions.timeWindow.endAtstring (date-time)Facultatif
conditions.timeWindow.daysOfWeekUtcarray<integer>Facultatif
conditions.timeWindow.startHourUtcintegerFacultatif≥ 0≤ 23
conditions.timeWindow.endHourUtcintegerFacultatif≥ 0≤ 24
configobject | nullFacultatif

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

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

Connectors