API referansı İngilizce yayımlanır.

List personal credential definitions (user secrets)

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

List personal credential definitions (user secrets).

Board-only organization-admin metadata for personal credential definitions, not their values. Agents cannot read this list using the human's identity. For an existing required personal credential, direct the current person to the organization-prefixed /company/settings/secrets page, My secrets, then Set my value for the matching definition. Organization admins can also open definition details with ?definition= when its ID is already known; other members use My secrets and Set my value. Only that signed-in person's value is set; another person's value cannot satisfy it. Never request values in chat. Storing a credential for an existing definition does not require choosing or connecting a new external provider.

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.

Yanıtlar

200SuccessThe request worked; the body holds the result.
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