Skip to main content
An integration is a service Lumos knows how to connect to. An app is one connected instance of an integration in your organization. okta.com is an integration. When your organization connects Okta, the result is an app. You read the two through different endpoints. Browse integrations to see what you could connect and what credentials each one needs. Read apps to see what you have connected. Integrations carry only catalog metadata. They hold nothing specific to your organization.
The Integration object

​
Attributes

app_class_id is the only field you need to look up or connect an integration. It’s the catalog’s identifier, the path parameter on the two lookup endpoints, and the app_class_id you send to Create App to connect it.

​
Which integrations are listed

This catalog is narrower than the catalog in the Lumos UI. List Integrations excludes SaaS products that Lumos discovers but has no integration for, because you can’t do anything with them through this API. A missing service is one Lumos can’t connect to through the API.

​
Connection schema

Read an integration’s connection schema before you connect it. Get Integration Connection Schema returns the JSON Schema of the auth and settings objects that Create App expects when it connects an integration. With it, you can write one connect flow instead of one per integration.
Check these four points before you build a connect request:
  • The shape depends on the integration. Most schemas are a flat object with credential keys at the top level. Integrations that support several authentication methods nest credentials under named groups, and your connect request must use the same nesting.
  • An empty auth_schema, {"type":"object","properties":{}}, doesn’t mean the integration needs no credentials. It means you don’t send credentials in the request, and auth_schema.description says why. Usually you finish the connection through browser consent in the Lumos UI, which you can’t do end to end through the API. For a few integrations, Lumos supplies the credential itself, and you connect with settings alone.
  • Instance identifiers go in settings, never in auth. Some integrations require app_instance_identifier there, such as an Okta domain. Others derive it from the credentials while connecting. On-prem integrations take on_prem_agent_cluster_id in the same place.
  • A 404 can happen for a listed integration. It means Lumos can’t describe that integration’s connection schema right now. For an on-prem integration, detail says what to do: connect an on-prem agent that runs the connector, or install the connector on one, then retry. For any other integration, connect it in the Lumos UI instead.

​
Endpoints