v68

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

Bulk index groups

Replaces the groups 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 groups deleted from the existing set will have their associated memberships deleted as well.

post/api/index/v1/bulkindexgroups

Request body

uploadIdstring required

Unique id that must be used for this instance of datasource groups 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 groups

disableStaleDataDeletionCheckboolean

True if older group 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