Skip to main content
GET
Get Integration Connection Schema

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_class_id
string
required

The integration's catalog identifier, such as okta.com, which GET /v1/integrations returns as app_class_id. It is not a UUID.

Response

Successful Response

An integration's connection schema — the auth and settings a caller must supply to connect it. Read it to discover how to connect an integration before connecting it.

app_class_id
string
required

Canonical identifier of the integration the schema is for (echoes the request).

auth_schema
Auth Schema · object
required

Draft-07 JSON Schema describing the auth object to pass to the Apps API's create endpoint. Properties are the credential keys the integration accepts; secret fields are marked writeOnly, and fixed-choice fields carry an enum. Most integrations use a flat object with credential keys at the top level; some nest credentials under named groups when the integration supports multiple authentication methods — mirror that nesting in the connect request. An empty object ({"type":"object","properties":{}}) means no credentials are supplied up front (the connection is completed via browser consent in the Lumos UI). A manually-set instance id belongs in settings_schema, not auth.

settings_schema
Settings Schema · object
required

JSON Schema of the non-secret settings object for the Apps API's create endpoint. Carries tenant URLs, routing configuration, and other non-secret values the integration needs beyond credentials. Some integrations require a manually-set instance id as app_instance_identifier (e.g. an Okta domain); others derive it from the credentials during connect. Integrations that run through an on-prem agent take on_prem_agent_cluster_id here. Integrations that need no non-secret configuration return an empty object.