Skip to main content
PATCH
Update Workspace Auth Connection

Headers

Idempotency-Key
string | null
Required string length: 8 - 128
If-Match
string | null

Quoted version from auth connection management details

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

auth_connection_id
string
required

Body

application/json

Updated auth connection fields

auth_type
string
default:oauth2_client_credentials
Allowed value: "oauth2_client_credentials"
provider
string | null
client_id
string | null
scopes
string[] | null
extra_params
Extra Params · object | null
basic_auth_in_header
boolean | null
client_secret
string | null
custom_headers
Custom Headers · object | null

Response

Successful Response

Response model for oauth2 client creds

name
string
required
provider
string
required
client_id
string
required
token_url
string
required
id
string
required
auth_type
string
default:oauth2_client_credentials
Allowed value: "oauth2_client_credentials"
scopes
string[]
extra_params
Extra Params · object
basic_auth_in_header
boolean
default:false

If True, send client credentials in Authorization header as Basic Auth instead of request body

used_by
AuthConnectionDependencies · object | null

Dependencies that use an auth connection

status
enum<string>
default:active

Single status field shared by every auth type's stored credential.

OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).

Available options:
active,
refresh_failed,
revoked,
credential_invalid
status_detail
string | null
status_updated_at
string | null
custom_headers
Custom Headers · object

Custom headers configured for OAuth2 token requests