La referencia de la API se publica en inglés.
Create a user secret definition
POST
/api/companies/{companyId}/user-secret-definitionsPersonal API keyConsole session
Create a user secret definition.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
companyIdstringObligatorioThe organization's id.
Cuerpo de la solicitud
application/json · obligatorio
keystringObligatorio
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$namestringObligatorio
1–160 charactersdescriptionstring | nullOpcional
at most 500 charactersstatusstringOpcional
one of: "active", "disabled", "archived"providerstringOpcional
one of: "local_encrypted", "aws_secrets_manager", "gcp_secret_manager", "vault"providerConfigIdstring (uuid) | nullOpcional
managedModestringOpcional
one of: "veyra_managed", "external_reference"providerMetadataobject | nullOpcional
usageGuidancestring | nullOpcional
at most 1000 charactersRespuestas
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.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.