API referansı İngilizce yayımlanır.

Create a tool access profile

POST/api/companies/{companyId}/tools/profiles
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create a tool access profile.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

profileKeystringZorunlu1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
namestringZorunlu1–160 characters
descriptionstring | nullİsteğe bağlıat most 4000 characters
statusstringİsteğe bağlıone of: "draft", "active", "disabled", "archived"
defaultActionstringİsteğe bağlıone of: "deny", "allow"
metadataobject | nullİsteğe bağlı
entriesarray<object>İsteğe bağlı
entries[].selectorTypestringZorunluone of: "application", "connection", "catalog_entry", "tool_name", "risk_level"
entries[].effectstringİsteğe bağlıone of: "include", "exclude"
entries[].applicationIdstring (uuid) | nullİsteğe bağlı
entries[].connectionIdstring (uuid) | nullİsteğe bağlı
entries[].catalogEntryIdstring (uuid) | nullİsteğe bağlı
entries[].toolNamestring | nullİsteğe bağlı1–240 characters
entries[].riskLevelstring | nullİsteğe bağlıone of: "low", "medium", "high", "critical", "read", "write", "destructive"
entries[].conditionsobject | nullİsteğe bağlı

Yanıtlar

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

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Connectors