Integrations

Get a provider

GET
/integrations/catalog/{provider_key}

Describe one provider: contract_digest, auth schemes with their public_config and credential fields, and every operation with input schema, risk_level, requires_space and constraint_policy. Read it before creating a connection or a grant.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

provider_key*string

Resource identifier: provider_key.

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/integrations/catalog/example"
{  "key": "summary",  "contract_digest": "example",  "display_name": "example",  "description": "example",  "category": "example",  "icon_key": "example",  "auth_schemes": [    {      "key": "summary",      "strategy": "example",      "public_config_schema": {},      "credential_schema": {},      "ui_schema": {},      "form_contract": {        "profile_version": "example",        "public_config": {}      }    }  ],  "operations": [    {      "key": "summary",      "resource": "example",      "operation": "example",      "description": "example",      "input_schema": {},      "output_schema": {},      "effect": "example",      "execution_mode": "example",      "risk_level": "example",      "requires_space": false,      "timeout_seconds": 0,      "max_retries": 0,      "rate_limit_requests": 0,      "rate_limit_window_seconds": 0,      "max_payload_bytes": 0,      "audit_fields": [],      "value_sources": {}    }  ],  "sources": [    {      "key": "summary",      "display_name": "example",      "list_operation": "example",      "import_operation": "example",      "scope_fields": [],      "item_id_field": "example",      "item_name_field": "example",      "item_change_fields": [],      "import_arguments": {},      "scope_sources": {},      "scan": "example"    }  ]}