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

Replace the organization skill policy

PUT/api/companies/{companyId}/skill-policy
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Replace the organization skill 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

schemaVersionnumberObligatoireone of: 1
defaultEffectstringObligatoireone of: "allow", "deny"
rulesarray<object>Obligatoire
rules[].idstringObligatoire1–128 characterspattern: ^[a-zA-Z0-9][a-zA-Z0-9._:-]*$
rules[].priorityintegerObligatoire≥ -1000000≤ 1000000
rules[].effectstringObligatoireone of: "allow", "deny"
rules[].subjectobjectObligatoire
rules[].actionsarray<string>Obligatoireitems one of: "skills.create", "skills.import", "skills.install", "skills.edit", "skills.update", "skills.test", "skills.reset", "skills.remove"
rules[].resourcesobjectFacultatif
rules[].resources.skillIdsarray<string (uuid)>Facultatif
rules[].resources.skillKeysarray<string>Facultatifeach at most 512 characters
rules[].resources.sourceTypesarray<string>Facultatifitems one of: "workspace", "catalog", "git", "external_package", "generated", "unknown"
rules[].resources.sourceLocatorsarray<string>Facultatifeach at most 2048 characters
expectedRevisionintegerObligatoire≥ 0

Réponses

200SuccessThe request worked; the body holds the result.
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.

Skills