API ReferenceAgent Auth

Connect a BYOK vendor key (temporarily unavailable)

Deprecated
Afficher en Markdown
Scope: agent_auth:write

Authentification

AuthorizationBearer

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, plugins:read, secrets:read, secrets:write, sessions:read, knowledge:read, repos:read, repos:write, reviews:read, reviews:write, analytics:read, org:read, org:write, attachments:read, attachments:write, plugins:write, guardrails:read, guardrails:write.

Paramètres de chemin

orgIdstringRequis

Organization id or slug. Resolve it with GET /v3/self.

providerstringRequis

Legacy agent-auth provider id. Provider connection operations are temporarily unavailable.

Requête

This endpoint expects an object.
keystringRequis
The provider's own API key. Stored encrypted, never returned.

Réponse

Legacy compatibility response (not currently returned).

Erreurs

400
Bad Request Error
410
Gone Error
503
Service Unavailable Error