API referansı İngilizce yayımlanır.

Create my user secret value

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

Create my user secret value.

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

definitionKeystringİsteğe bağlı1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
definitionIdstring (uuid)İsteğe bağlı
valuestring | nullİsteğe bağlıat least 1 character
externalRefstring | nullİsteğe bağlı
providerVersionRefstring | nullİsteğe bağlı
providerConfigIdstring (uuid) | 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