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

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.

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.

session_id*string

The session_id Start signing in answered (cs_ and a ULID).

Response Body

iohr.connections.v1.GetConnectSessionResponse

application/json
  1. response

iohr.connections.v1.GetConnectSessionResponse

connection?

iohr.connections.v1.Connection

error*string
expires_at*string
status*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.getConnectSession("<org_id>", "<session_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"    ]  },  "error": "string",  "expires_at": "string",  "status": "string"}

Complete a sign-in POST

Called by the console's callback page as the person who started the sign-in, with the `state` and `code` the provider sent back (or its `error`). Exchanges the code with the PKCE verifier, seals the tokens (never answered), runs the connector's test and answers the connection with its `label`, granted `scopes`, `token_expires_at` and `external_id`. A workspace the account already connected is updated, not connected twice. The state works once. Needs scope `connections:write`.

Get a connection GET

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