Справочник API публикуется на английском языке.
Create a user secret definition
POST
/api/companies/{companyId}/user-secret-definitionsPersonal API keyConsole session
Create a user secret definition.
Авторизация
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
keystringОбязательный
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$namestringОбязательный
1–160 charactersdescriptionstring | nullНеобязательный
at most 500 charactersstatusstringНеобязательный
one of: "active", "disabled", "archived"providerstringНеобязательный
one of: "local_encrypted", "aws_secrets_manager", "gcp_secret_manager", "vault"providerConfigIdstring (uuid) | nullНеобязательный
managedModestringНеобязательный
one of: "veyra_managed", "external_reference"providerMetadataobject | nullНеобязательный
usageGuidancestring | nullНеобязательный
at most 1000 charactersОтветы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.