Trigger App Sync

Trigger a sync for a connected app on demand (e.g. from automation, after Terraform has connected it). The sync runs asynchronously — the call returns 202 Accepted once the sync is launched; poll GET /apps/{app_id} to follow status.

Requires sync_type (only full_sync is supported today). The app must be connected or in an error state from a prior sync (so callers can retry after failure). Manual/CSV apps are not supported. Only one sync may run at a time: while a sync is in flight the request is rejected with 409 — wait for the running sync to finish, then retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
const
enum
required

Which sync to run. Required. Today only full_sync (a full integration sync that re-pulls accounts, groups, and entitlements) is supported; any other value is rejected with 422. The field is required even with one value so the contract stays stable as more sync kinds are added.

Allowed:
Responses

400

Bad request — the request could not be processed. Common causes: missing or malformed credentials, an unknown app_class_id, or an invalid configuration value. See the detail field for the specific reason.

403

Forbidden — the caller lacks permission to manage apps on this domain.

404

Not found — no app with this id in your domain.

409

Conflict — a sync is already running for this app, the app is not in a syncable state, or its first sync is deferred pending admin review (match rules, or a flatfile column mapping) in the Lumos UI.

422

Unprocessable — sync_type is missing or not a supported value, or the app is a manual/CSV app, which cannot be synced via this endpoint.

501

Not implemented — this app does not support the requested operation.

502

Bad gateway — the downstream sync launch failed.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json