Get Integration Connection Schema
Get the connection schema for an integration — the JSON schema of the auth and settings fields needed to connect it via POST /apps. Use it to discover how to connect an integration before connecting it (e.g. to populate a Terraform resource). app_class_id is the canonical identifier (e.g. okta.com, slack_ics) — the same value the connect body uses. Integrations whose connection schema Lumos cannot describe yet return 404.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
An integration's connection schema — the auth and settings a caller
must supply to connect it — so the Terraform provider and SDK consumers can
discover how to connect an integration before connecting it. Field
descriptions flow verbatim into the generated OpenAPI spec, so they double
as the public reference.
Canonical identifier of the integration the schema is for (echoes the request).
JSON Schema (draft-07 style) describing the auth object to pass to POST /apps. 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.
JSON Schema of the non-secret settings object for POST /apps. 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.