Sign in

v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0144101120.9 KB
Permissions

Bulk index users

Replaces the users in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints. Note: Any users deleted from the existing set will have their associated memberships deleted as well.

post/api/index/v1/bulkindexusers

Request body

uploadIdstring required

Unique id that must be used for this instance of datasource users upload

isFirstPageboolean

true if this is the first page of the upload. Defaults to false

isLastPageboolean

true if this is the last page of the upload. Defaults to false

forceRestartUploadboolean

Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true

datasourcestring required

datasource of the users

disableStaleDataDeletionCheckboolean

True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when isLastPage = true

Response

OK