API referansı İngilizce yayımlanır.

Create an organization secret credential

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

Create an organization secret credential.

Board-only secure credential entry. An agent cannot create the value on behalf of the human. Direct the human to New secret on the organization-prefixed /company/settings/secrets page; never request the value in chat. After entry, use only the intended consumer's secret reference, not plaintext or a grant to every agent. A saved credential is not proof of runtime delivery.

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

namestringZorunluat least 1 character
keystringİsteğe bağlı1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
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"
valuestring | nullİsteğe bağlıat least 1 character
descriptionstring | nullİsteğe bağlı
externalRefstring | nullİsteğe bağlı
providerMetadataobject | nullİsteğe bağlı
providerVersionRefstring | 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.

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

Secrets