SCscalekit
App Connections

Get a connection

Changed on

Returns a connection with its settings, looked up by its name or its ID. Use it to check the scopes the connection requests, or to copy its redirect_uri into the app you registered with the provider. Secrets come back masked.

get/api/v1/agentkit/connection/{connection_identifier}

Request

Path parameters

connection_identifierstring required

The connection's name, such as gmail-work, or its ID, such as conn_70219645518265104. Both are in the List connections response.

Response

The connection and its settings.

Example response

{
  "connection": {
    "connection_mcp_url": "https://yourapp.scalekit.dev/mcp/v3/connections/gmail-work",
    "connection_name": "gmail-work",
    "create_time": "2023-01-15T14:30:00Z",
    "google_dwd_config": {
      "required_scopes": [
        "https://www.googleapis.com/auth/gmail.readonly"
      ],
      "scope_selection_allowed": true,
      "scopes": [
        "https://www.googleapis.com/auth/gmail.readonly"
      ],
      "service_account_json": "{\"type\":\"service_account\",\"project_id\":\"my-project\",\"private_key_id\":\"0123456789abcdef\",\"private_key\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvQ...\\n-----END PRIVATE KEY-----\\n\",\"client_email\":\"dwd-sa@my-project.iam.gserviceaccount.com\",\"client_id\":\"123456789012345678901\"}"
    },
    "id": "conn_2123312131125533",
    "oauth_config": {
      "access_type": "offline",
      "authorize_uri": "https://youridp.com/service/oauth/authorize",
      "client_id": "123456789012-abc123def456.apps.googleusercontent.com",
      "client_secret": "GOCSPX-your-client-secret",
      "extra_authorize_params": {
        "hd": "example.com"
      },
      "optional_scopes": {
        "field_name": "optional_scope or bot_scope",
        "scopes": [
          "scope1",
          "scope2"
        ]
      },
      "pkce_enabled": true,
      "prompt": "consent",
      "redirect_uri": "https://yourapp.scalekit.dev/sso/v1/oauth/conn_24832952112323587/callback",
      "required_optional_scopes": [
        "search:read"
      ],
      "required_scopes": [
        "https://www.googleapis.com/auth/gmail.readonly"
      ],
      "scope_selection_allowed": true,
      "scopes": [
        "https://www.googleapis.com/auth/gmail.readonly",
        "https://www.googleapis.com/auth/gmail.send"
      ],
      "token_access_type": "offline",
      "token_uri": "https://youridp.com/service/oauth/token",
      "use_scalekit_creds": true,
      "user_info_uri": "https://youridp.com/service/oauth/userinfo"
    },
    "provider": "GMAIL",
    "provider_configurations": {
      "googleads_developer_token": "ABcDeFgHiJkLmNoPqRsTuV",
      "microsoft_tenant_id": "72f988bf-86f1-41af-91ab-2d7cd011db47",
      "provider_domain": "mcp-eu.mixpanel.com",
      "slack_connection_type": "USER",
      "smart_fhir_aud": "https://fhir.example.com/r4",
      "smart_fhir_domain": "fhir.example.com",
      "trello_app_name": "My Trello App"
    },
    "update_time": "2023-02-20T09:15:30Z"
  }
}

Changes