Skip to main content
POST

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Input object to create a download request

context
enum<string>
required

Selects which dataset the download request exports. The request and polling flow are identical for every value — only the returned data differs. The contexts below use the same catalog as the Working with Downloads guide, which also documents the filter and sort grammar.

oleriaUsers is an administrative context, not customer-facing identity data.

Available options:
accessInventoryAccounts,
accessInventoryApplicationAccountsV2,
accessInventoryApplicationInstancesV2,
accessInventoryEmployeesV2,
accessInventoryGroupsV2,
accessInventoryIdentitiesV2,
accessInventoryNhiV2,
accessInventoryResourceInstancesV2,
accessInventoryRolesV2,
accessRequests,
accountUtilization,
activityAnalysis,
applicationAccounts,
employeeAccessInsights,
employees,
externalAccessUsers,
externalAnonymousAccess,
externalSharedAssets,
groupUtilizationAccounts,
identities,
identityAssessmentEntitlementUtilization,
identityAssessmentResourceInstanceUtilization,
identityAssessmentRiskDownload,
identityAssessmentSimilarGroups,
ilmEmployeeEvents,
ilmEventAccountActions,
ilmEventApplicationActions,
ilmEventGroupActions,
ilmWorkflowEmployeeEvents,
oleriaUsers,
resourceInstances,
riskMonitoringDetail,
risks,
risksV2,
unmanagedApplications,
userGroup
fileFormat
enum<string>
default:csv

Selects the file format the download request exports. Defaults to csv when omitted.

Available options:
csv,
jsonl
params
object
downloadUrlTtlMinutes
integer
default:5

Duration that the presigned download URL is valid in minutes. Defaults to 5 minutes if no value is given. Cannot be greater than 4320 minutes (3 days).

Required range: 1 <= x <= 4320

Response

Download request created successfully

Tracks the status of a download request

id
string<uuid>
required
context
enum<string>
required

Selects which dataset the download request exports. The request and polling flow are identical for every value — only the returned data differs. The contexts below use the same catalog as the Working with Downloads guide, which also documents the filter and sort grammar.

oleriaUsers is an administrative context, not customer-facing identity data.

Available options:
accessInventoryAccounts,
accessInventoryApplicationAccountsV2,
accessInventoryApplicationInstancesV2,
accessInventoryEmployeesV2,
accessInventoryGroupsV2,
accessInventoryIdentitiesV2,
accessInventoryNhiV2,
accessInventoryResourceInstancesV2,
accessInventoryRolesV2,
accessRequests,
accountUtilization,
activityAnalysis,
applicationAccounts,
employeeAccessInsights,
employees,
externalAccessUsers,
externalAnonymousAccess,
externalSharedAssets,
groupUtilizationAccounts,
identities,
identityAssessmentEntitlementUtilization,
identityAssessmentResourceInstanceUtilization,
identityAssessmentRiskDownload,
identityAssessmentSimilarGroups,
ilmEmployeeEvents,
ilmEventAccountActions,
ilmEventApplicationActions,
ilmEventGroupActions,
ilmWorkflowEmployeeEvents,
oleriaUsers,
resourceInstances,
riskMonitoringDetail,
risks,
risksV2,
unmanagedApplications,
userGroup
fileFormat
enum<string>
default:csv
required

Selects the file format the download request exports. Defaults to csv when omitted.

Available options:
csv,
jsonl
status
enum<string>
required
Available options:
accepted,
completed,
failed
urlTtlMinutes
integer
required

Duration that the presigned download URL is valid in minutes.

Required range: 1 <= x <= 4320
error
object
url
string

A presigned URL to the S3 object containing the result data.