Skip to main content
POST
Trigger App Sync

Authorizations

Authorization
string
header
required

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

Path Parameters

app_uuid
string
required

The app's ID, which GET /v1/apps returns as id.

Body

application/json

Body of POST /v1/apps/{app_uuid}:sync.

sync_type
enum<string>
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 400. The field is required even with one value so the contract stays stable as more sync kinds are added.

Available options:
full-sync
skip_first_sync_review
boolean
default:false

Set to true to start the app's first sync without an admin reviewing its match rules. A newly connected app's first sync is held for that review and stays deferred until it's started from the Lumos UI or with this flag, so without the flag the request returns 409. It has no effect once the app has completed a sync successfully; a retry after a failed first sync is held for review again and needs the flag once more.

Response

Successful Response

202 response body for endpoints that launch an operation.

operation
OperationOutput · object
required

The launched operation.