v1

latestOpenAPI 3.1.02026-07-2210284274.4 KB
Agent Compliance

Save OAuth 2.0 client-credentials for an agent

Store a machine-to-machine OAuth 2.0 client-credentials configuration (RFC 6749 §4.4) for this agent. The SDK exchanges at the token endpoint before every call and refreshes on 401. client_secret may be a $ENV:VAR_NAME reference — the SDK resolves at exchange time, the server stores it as written (encrypted uniformly). Requires authentication and ownership.

put/api/registry/agents/{encodedUrl}/oauth-client-credentials

Path parameters

encodedUrlstring required

URL-encoded agent URL

URL-encoded agent URL

Request body

token_endpointstring required

Token endpoint URL (HTTPS required; localhost allowed in dev).

client_idstring required

OAuth client ID. May be a $ENV:VAR_NAME reference.

client_secretstring required

OAuth client secret. May be a $ENV:VAR_NAME reference. Stored encrypted at rest.

scopestring

Space-separated OAuth scope values.

resourcestring

RFC 8707 resource indicator.

audiencestring

Audience parameter for audience-validating authorization servers.

auth_method'basic' | 'body'

Client-credentials placement: basic (HTTP Basic header, RFC 6749 §2.3.1 preferred) or body (form fields). SDK default is basic.

Response

Credentials saved

connectedtrue required
has_authtrue required
agent_context_idstring required
auth_type'oauth_client_credentials' required