Справочник API публикуется на английском языке.

Replace the organization skill policy

PUT/api/companies/{companyId}/skill-policy
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Replace the organization skill policy.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

schemaVersionnumberОбязательныйone of: 1
defaultEffectstringОбязательныйone of: "allow", "deny"
rulesarray<object>Обязательный
rules[].idstringОбязательный1–128 characterspattern: ^[a-zA-Z0-9][a-zA-Z0-9._:-]*$
rules[].priorityintegerОбязательный≥ -1000000≤ 1000000
rules[].effectstringОбязательныйone of: "allow", "deny"
rules[].subjectobjectОбязательный
rules[].actionsarray<string>Обязательныйitems one of: "skills.create", "skills.import", "skills.install", "skills.edit", "skills.update", "skills.test", "skills.reset", "skills.remove"
rules[].resourcesobjectНеобязательный
rules[].resources.skillIdsarray<string (uuid)>Необязательный
rules[].resources.skillKeysarray<string>Необязательныйeach at most 512 characters
rules[].resources.sourceTypesarray<string>Необязательныйitems one of: "workspace", "catalog", "git", "external_package", "generated", "unknown"
rules[].resources.sourceLocatorsarray<string>Необязательныйeach at most 2048 characters
expectedRevisionintegerОбязательный≥ 0

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Skills