One connection of the account.
Needs scope connections:read.
bearerAuthorizationBearer <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.
org_id*stringThe account's id: org in GET /v1/me.
connection_id*stringThe connection's id, con_ and a ULID, from List connections.
iohr.connections.v1.GetConnectionResponse
application/json- response
iohr.connections.v1.GetConnectionResponse
connection?iohr.connections.v1.Connection
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.getConnection("<org_id>", "<connection_id>"); 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" ] }}Get a sign-in GET
Where a sign-in stands, for a command line waiting on the browser: `pending`, `completed` (with the connection), `failed` (with why) or `expired`. Only the person who started it may read it. Needs scope `connections:read`.
Update a connection PATCH
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`.