Справочник API публикуется на английском языке.
Update a tool access profile
PATCH
/api/tool-profiles/{profileId}Personal API keyAgent API keyConsole session
Update a tool access profile.
Авторизация
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. Как работают ключи.
Параметры пути
profileIdstringОбязательныйThe profile's id.
Тело запроса
application/json · обязательно
profileKeystringНеобязательный
1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$namestringНеобязательный
1–160 charactersdescriptionstring | nullНеобязательный
at most 4000 charactersstatusstringНеобязательный
one of: "draft", "active", "disabled", "archived"defaultActionstringНеобязательный
one of: "deny", "allow"metadataobject | nullНеобязательный
entriesarray<object>Необязательный
entries[].selectorTypestringОбязательный
one of: "application", "connection", "catalog_entry", "tool_name", "risk_level"entries[].effectstringНеобязательный
one of: "include", "exclude"entries[].applicationIdstring (uuid) | nullНеобязательный
entries[].connectionIdstring (uuid) | nullНеобязательный
entries[].catalogEntryIdstring (uuid) | nullНеобязательный
entries[].toolNamestring | nullНеобязательный
1–240 charactersentries[].riskLevelstring | nullНеобязательный
one of: "low", "medium", "high", "critical", "read", "write", "destructive"entries[].conditionsobject | nullНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.