View as Markdown
Universal API icon

Universal API ACTION

Update Connection

Update a connection identified by universalApi and serviceId via the Platform API on Universal API (PATCH; only supplied fields are changed). Run List Connections first to find the correct serviceId. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Universal API account once, then configure and run Update Connection from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "universal_api-update-connection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    universal_api: { authProvisionId: "apn_xxxxxxx" },
    consumerId: "Consumer ID",
    universalApi: "Universal API",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Connection inputs
Property Type Description
consumerId Consumer ID string
The consumer ID. Run List Consumers first to find valid IDs.
Required
universalApi Universal API string
The Universal API to use.
Required
serviceId Service ID string
The service ID that, together with universalApi, identifies the connection (e.g. kandji, jamf, teamtailor).
Required
apiKey API Key string
Required for BambooHR, Teamtailor, Bring, Posti, PostNord, Hexnode.
Optional
domain Domain string
Required for Velory, BambooHR, Kandji, Hexnode.
Optional
email Email string
Required for Velory.
Optional
password Password string
Required for Velory.
Optional
accessToken Access Token string
Required for Kandji, HaileyHR, Deel.
Optional
clientId Client ID string
Required for CatalystOne, Fedex.
Optional
clientSecret Client Secret string
Required for CatalystOne, Fedex.
Optional
serviceUserId Service User ID string
Required for HiBob.
Optional
serviceUserToken Service User Token string
Required for HiBob.
Optional
login Login string
Required for Bring.
Optional
apiSecret API Secret string
Required for Posti.
Optional
ssoUrl SSO URL string
Required for AzureSAML, GoogleSAML.
Optional
certificate Certificate string
Required for AzureSAML, GoogleSAML.
Optional
ipEntityId IP Entity ID string
Required for AzureSAML, GoogleSAML.
Optional
enabled Enabled boolean
Whether the connection is enabled.
Optional
redirectUri Redirect URI string
Required for AzureSAML, GoogleSAML. Optional for GoogleWorkspace, Azure Active Directory, Microsoft Intune, Google Devices.
Optional
acsUrl ACS URL string
Required for AzureSAML, GoogleSAML.
Optional
spEntityId SP Entity ID string
Required for AzureSAML, GoogleSAML.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
universal_api-update-connection
Version
0.0.2
App
Universal API
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes