La référence de l'API est publiée en anglais.
Create a tool access profile
POST
/api/companies/{companyId}/tools/profilesPersonal API keyAgent API keyConsole session
Create a tool access profile.
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
profileKeystringObligatoire
1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$namestringObligatoire
1–160 charactersdescriptionstring | nullFacultatif
at most 4000 charactersstatusstringFacultatif
one of: "draft", "active", "disabled", "archived"defaultActionstringFacultatif
one of: "deny", "allow"metadataobject | nullFacultatif
entriesarray<object>Facultatif
entries[].selectorTypestringObligatoire
one of: "application", "connection", "catalog_entry", "tool_name", "risk_level"entries[].effectstringFacultatif
one of: "include", "exclude"entries[].applicationIdstring (uuid) | nullFacultatif
entries[].connectionIdstring (uuid) | nullFacultatif
entries[].catalogEntryIdstring (uuid) | nullFacultatif
entries[].toolNamestring | nullFacultatif
1–240 charactersentries[].riskLevelstring | nullFacultatif
one of: "low", "medium", "high", "critical", "read", "write", "destructive"entries[].conditionsobject | 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.