API ReferenceTreasury Integration Definitions

Update a Treasury integration definition

Beta

Update an integration definition. Omit a secret key to keep its stored value (carry-forward). Admin only.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

definition_idstringRequired

Request

This endpoint expects an object.
configmap from strings to anyRequired

Non-secret connection body.

labelstringRequired
Human name distinguishing this connection method.
providerstringRequired

Vendor family (normalized lowercase).

scopestringRequired

global | workspace | user.

authMethodstringOptionalDefaults to oauth2

oauth2 | oauth_client_credentials | oauth_ropc | api_key | pat | paragon.

enabledbooleanOptionalDefaults to true
Whether the definition is active.
ownerUserIdstring or nullOptional

Owning user; required when scope=user.

secretsmap from strings to strings or nullOptional

Write-only {secret_key: value} (e.g. client_secret). Never returned.

workspaceIdstring or nullOptional

Owning workspace (defaults to the caller’s workspace when scope=workspace).

Response

Successful Response
auth_methodstring

oauth2 | oauth_client_credentials | … | paragon.

configmap from strings to any

Non-secret connection body.

created_atstringformat: "date-time"

Creation timestamp (UTC).

enabledboolean
Whether the definition can be used to mint.
has_secretsmap from strings to booleans

Map of secret-key → whether it is set.

idstring

Stable definition id (tid_*).

labelstring
Human name distinguishing methods of one provider.
providerstring

Vendor family, e.g. databricks_direct.

scopestring

global | workspace | user.

updated_atstringformat: "date-time"

Last-update timestamp (UTC).

created_bystring or null
Creator user id, if known.
owner_user_idstring or null

Owning user (scope=user).

workspace_idstring or null

Owning workspace (scope=workspace).

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error