API referansı İngilizce yayımlanır.

Create a user secret definition

POST/api/companies/{companyId}/user-secret-definitions
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 4 · Geçmiş

Create a user secret definition.

Yetkilendirme

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

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

keystringZorunlu1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
namestringZorunlu1–160 characters
descriptionstring | nullİsteğe bağlıat most 500 characters
statusstringİsteğe bağlıone of: "active", "disabled", "archived"
providerstringİsteğe bağlıone of: "local_encrypted", "aws_secrets_manager", "gcp_secret_manager", "vault"
providerConfigIdstring (uuid) | nullİsteğe bağlı
managedModestringİsteğe bağlıone of: "veyra_managed", "external_reference"
providerMetadataobject | nullİsteğe bağlı
usageGuidancestring | nullİsteğe bağlıat most 1000 characters

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.

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

Secrets