La référence de l'API est publiée en anglais.

Create a user secret definition

POST/api/companies/{companyId}/user-secret-definitions
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

Create a user secret definition.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

keystringObligatoire1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
namestringObligatoire1–160 characters
descriptionstring | nullFacultatifat most 500 characters
statusstringFacultatifone of: "active", "disabled", "archived"
providerstringFacultatifone of: "local_encrypted", "aws_secrets_manager", "gcp_secret_manager", "vault"
providerConfigIdstring (uuid) | nullFacultatif
managedModestringFacultatifone of: "veyra_managed", "external_reference"
providerMetadataobject | nullFacultatif
usageGuidancestring | nullFacultatifat most 1000 characters

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Secrets