La référence de l'API est publiée en anglais.
Create a tool policy
POST
/api/companies/{companyId}/tools/policiesPersonal API keyAgent API keyConsole session
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
namestringObligatoire
1–160 charactersdescriptionstring | nullFacultatif
at most 4000 characterspolicyTypestringObligatoire
one of: "allow", "block", "require_approval", "trust_rule", "rate_limit"priorityintegerFacultatif
≥ 0≤ 10000enabledbooleanFacultatif
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>Facultatif
each at most 120 charactersconditions.arguments.fieldAbsentarray<string>Facultatif
each at most 120 charactersconditions.argsobjectFacultatif
conditions.args.fieldEqualsobjectFacultatif
conditions.args.fieldNotEqualsobjectFacultatif
conditions.args.fieldInobject<string, array<any>>Facultatif
conditions.args.fieldMatchesobject<string, string>Facultatif
conditions.args.fieldExistsarray<string>Facultatif
each at most 120 charactersconditions.args.fieldAbsentarray<string>Facultatif
each at most 120 charactersconditions.actorobjectFacultatif
conditions.actor.actorTypestringFacultatif
one of: "agent", "user", "system", "plugin"conditions.actor.actorTypesarray<string>Facultatif
items 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>Facultatif
items one of: "low", "medium", "high", "critical", "read", "write", "destructive"conditions.risk.maxstringFacultatif
one 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.applicationKeystringFacultatif
1–160 charactersconditions.credentialScope.applicationKeysarray<string>Facultatif
each at most 160 charactersconditions.credentialScope.providerTypestringFacultatif
1–160 charactersconditions.credentialScope.providerTypesarray<string>Facultatif
each at most 160 charactersconditions.trustBoundaryobjectFacultatif
conditions.trustBoundary.providerTypestringFacultatif
1–160 charactersconditions.trustBoundary.providerTypesarray<string>Facultatif
each at most 160 charactersconditions.trustBoundary.applicationKeystringFacultatif
1–160 charactersconditions.trustBoundary.applicationKeysarray<string>Facultatif
each at most 160 charactersconditions.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≤ 23conditions.timeWindow.endHourUtcintegerFacultatif
≥ 0≤ 24configobject | 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.