Skip to main content
POST
/
v1
/
downloads
curl --request POST \
  --url https://devx.{tenant}.oleria.io/v1/downloads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": "accessInventoryIdentitiesV2"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "url": "<string>"
}

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.

Groupcontext valuesWhat it returns
Access InventoryaccessInventoryIdentitiesV2, accessInventoryEmployeesV2, accessInventoryNhiV2, accessInventoryAccounts, accessInventoryApplicationAccountsV2, accessInventoryApplicationInstancesV2, accessInventoryGroupsV2, accessInventoryRolesV2, accessInventoryResourceInstancesV2Snapshots of who has access to what, by identity / account / group / role.
Identity & Employeesidentities, employees, employeeAccessInsights, oleriaUsersCanonical identity and HR records, plus per-employee access posture.
UtilizationaccountUtilization, groupUtilizationAccountsActivity-weighted views of how access is actually used.
Risk & Activityrisks, risksV2, riskMonitoringDetail, activityAnalysisDetected risks, monitoring detail, and the raw activity log.
Identity AssessmentsidentityAssessmentRiskDownload, identityAssessmentEntitlementUtilization, identityAssessmentResourceInstanceUtilization, identityAssessmentSimilarGroupsPeriodic assessment outputs across entitlements and resources.
Identity Lifecycle (ILM)ilmEmployeeEvents, ilmWorkflowEmployeeEvents, ilmEventAccountActions, ilmEventApplicationActions, ilmEventGroupActionsJoiner / mover / leaver events, the workflows they triggered, and the per-event account / application / group provisioning actions performed for each one.
External AccessexternalAccessUsers, externalAnonymousAccess, externalSharedAssetsThird-party users, anonymous shares, and externally shared assets.
Access RequestsaccessRequestsSubmitted access requests and their status.
ReferenceresourceInstances, unmanagedApplications, applicationAccounts, userGroupResource and application catalog data.

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
params
object

Response

Download request created successfully

Tracks the status of a download request

id
string<uuid>
required
status
enum<string>
required
Available options:
accepted,
completed,
failed
error
object
url
string

A presigned URL to the S3 object containing the result data, valid for 5 minutes