Get details of a specific connection, including credentials
import Openint from '@openint/sdk';
const client = new Openint({
token: 'My Token',
});
const response = await client.getConnection('conn_');
console.log(response);
{
"id": "<string>",
"customer_id": "<string>",
"connector_config_id": "<string>",
"integration_id": "<string>",
"status_message": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"display_name": "<string>",
"disabled": true,
"status": "healthy",
"metadata": {},
"connector_name": "<string>",
"settings": {
"oauth": {
"credentials": {
"access_token": "<string>",
"client_id": "<string>",
"scope": "<string>",
"refresh_token": "<string>",
"expires_in": 123,
"expires_at": "<string>",
"token_type": "<string>",
"raw": {}
},
"created_at": "<string>",
"updated_at": "<string>",
"last_fetched_at": "<string>",
"metadata": {}
},
"access_token": "<string>",
"subdomain": "<string>"
},
"connector": {
"name": "<string>",
"display_name": "<string>",
"logo_url": "<string>",
"stage": "alpha",
"platforms": [
"web"
],
"schemas": {
"connector_config": "<any>",
"connection_settings": "<any>",
"integration_data": "<any>",
"webhook_input": "<any>",
"pre_connect_input": "<any>",
"connect_input": "<any>",
"connect_output": "<any>"
},
"auth_type": "BASIC",
"required_scopes": [
"<string>"
],
"openint_default_scopes": [
"<string>"
],
"openint_allowed_scopes": [
"<string>"
],
"scopes": [
{
"scope": "<string>",
"display_name": "<string>",
"description": "<string>"
}
],
"has_openint_credentials": true
},
"integration": {
"id": "<string>",
"standard": "<string>",
"external": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"connector_name": "accelo",
"name": "<string>",
"logo_url": "<string>",
"stage": "alpha",
"platforms": [
"web"
],
"category": "<string>",
"auth_type": "<string>",
"version": "<string>"
}
}
Organization API Key available in the settings page of the OpenInt Console or Customer API Key or Token Customer authentication token created using the create customer token API. It is passed in the authorization
header with format: Bearer {token}
The id of the connection, starts with conn_
Controls credential refresh: none (never), force (always), or auto (when expired, default)
none
, force
, auto
Show child attributes
Successful response
The connection details
import Openint from '@openint/sdk';
const client = new Openint({
token: 'My Token',
});
const response = await client.getConnection('conn_');
console.log(response);
{
"id": "<string>",
"customer_id": "<string>",
"connector_config_id": "<string>",
"integration_id": "<string>",
"status_message": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"display_name": "<string>",
"disabled": true,
"status": "healthy",
"metadata": {},
"connector_name": "<string>",
"settings": {
"oauth": {
"credentials": {
"access_token": "<string>",
"client_id": "<string>",
"scope": "<string>",
"refresh_token": "<string>",
"expires_in": 123,
"expires_at": "<string>",
"token_type": "<string>",
"raw": {}
},
"created_at": "<string>",
"updated_at": "<string>",
"last_fetched_at": "<string>",
"metadata": {}
},
"access_token": "<string>",
"subdomain": "<string>"
},
"connector": {
"name": "<string>",
"display_name": "<string>",
"logo_url": "<string>",
"stage": "alpha",
"platforms": [
"web"
],
"schemas": {
"connector_config": "<any>",
"connection_settings": "<any>",
"integration_data": "<any>",
"webhook_input": "<any>",
"pre_connect_input": "<any>",
"connect_input": "<any>",
"connect_output": "<any>"
},
"auth_type": "BASIC",
"required_scopes": [
"<string>"
],
"openint_default_scopes": [
"<string>"
],
"openint_allowed_scopes": [
"<string>"
],
"scopes": [
{
"scope": "<string>",
"display_name": "<string>",
"description": "<string>"
}
],
"has_openint_credentials": true
},
"integration": {
"id": "<string>",
"standard": "<string>",
"external": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"connector_name": "accelo",
"name": "<string>",
"logo_url": "<string>",
"stage": "alpha",
"platforms": [
"web"
],
"category": "<string>",
"auth_type": "<string>",
"version": "<string>"
}
}