API ReferenceAgent Auth

Connect a BYOK vendor key (temporarily unavailable)

Deprecated
Als Markdown anzeigen
Scope: agent_auth:write

Authentifizierung

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.

Pfadparameter

orgIdstringErforderlich

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

providerstringErforderlich

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

Anfrage

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

Antwort

Legacy compatibility response (not currently returned).

Fehler

400
Bad Request Error
410
Gone Error
503
Service Unavailable Error