InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
PATCH
/v1/accounts/orgs/{org_id}/connections/{connection_id}

Rename, describe, pause or resume a connection, replace its configuration or credential, or rotate a webhook-in secret (answered once; the previous one verifies for a day). A connector reconnects with credentials (and auth_mode to switch modes): the new key is tested first, a refusal changes nothing, a pass makes it active and refreshes its label. A field left out keeps its value.

Needs scope connections:write.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

connection_id*string

The connection's id, con_ and a ULID, from List connections.

Request Body

iohr.connections.v1.UpdateConnectionRequest; path variables override their fields

application/json
  1. body

iohr.connections.v1.UpdateConnectionRequest

auth_mode?string
config?
connection_id?string
credentials?
description?string
name?string
org_id?string
paused?boolean
rotate_webhook_secret?boolean
secret?string
secret_ref?string

Response Body

iohr.connections.v1.UpdateConnectionResponse

application/json
  1. response

iohr.connections.v1.UpdateConnectionResponse

connection?

iohr.connections.v1.Connection

webhook_secret*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.connections.updateConnection("<org_id>", "<connection_id>", {    auth_mode: "<auth_mode>",    description: "<description>",    name: "<name>",    secret: "<secret>",  });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{  "connection": {    "account_id": "string",    "auth_mode": "string",    "config": {      "property1": "string",      "property2": "string"    },    "connector": "string",    "created_at": "string",    "credential": {      "kind": "string",      "reference": "string",      "set_at": "string"    },    "description": "string",    "executor": {      "agent_id": "string",      "kind": "string"    },    "external_id": "string",    "grants": 0,    "id": "string",    "kind": "string",    "label": "string",    "last_test_at": "string",    "last_test_error": "string",    "last_test_ok": true,    "name": "string",    "owner": "string",    "receive_url": "string",    "scopes": [      "string"    ],    "status": "string",    "token_expires_at": "string",    "updated_at": "string",    "used_by": [      "string"    ]  },  "webhook_secret": "string"}

Get a connection GET

One connection of the account. Needs scope `connections:read`.

Delete a connection DELETE

Deletes the connection with its sealed credential, its grants and its history. A token from signing in is revoked at the provider first, where the provider supports it. Needs scope `connections:write`.